From 8dc73d2dc6db62bed0fb75c71079dbdf06131cda Mon Sep 17 00:00:00 2001 From: Tim Peters Date: Mon, 24 Apr 2006 02:03:16 +0000 Subject: [PATCH] Bug #1337990: clarified that `doctest` does not support examples requiring both expected output and an exception. I'll backport to 2.4 next. --- Doc/lib/libdoctest.tex | 11 +++++++---- Misc/NEWS | 2 ++ 2 files changed, 9 insertions(+), 4 deletions(-) diff --git a/Doc/lib/libdoctest.tex b/Doc/lib/libdoctest.tex index 0e3a017c0d0..7c4cb417693 100644 --- a/Doc/lib/libdoctest.tex +++ b/Doc/lib/libdoctest.tex @@ -407,10 +407,13 @@ You can force use of your own dict as the execution context by passing \subsubsection{What About Exceptions?\label{doctest-exceptions}} No problem, provided that the traceback is the only output produced by -the example: just paste in the traceback. Since tracebacks contain -details that are likely to change rapidly (for example, exact file paths -and line numbers), this is one case where doctest works hard to be -flexible in what it accepts. +the example: just paste in the traceback.\footnote{Examples containing + both expected output and an exception are not supported. Trying + to guess where one ends and the other begins is too error-prone, + and that also makes for a confusing test.} +Since tracebacks contain details that are likely to change rapidly (for +example, exact file paths and line numbers), this is one case where doctest +works hard to be flexible in what it accepts. Simple example: diff --git a/Misc/NEWS b/Misc/NEWS index 6f3880ed2cd..8788c584407 100644 --- a/Misc/NEWS +++ b/Misc/NEWS @@ -171,6 +171,8 @@ Tools Documentation ------------- +- Bug #1337990: clarified that ``doctest`` does not support examples + requiring both expected output and an exception. What's New in Python 2.5 alpha 1?