]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
Merge rev 45677 from the trunk.
authorTim Peters <tim.peters@gmail.com>
Mon, 24 Apr 2006 02:07:13 +0000 (02:07 +0000)
committerTim Peters <tim.peters@gmail.com>
Mon, 24 Apr 2006 02:07:13 +0000 (02:07 +0000)
Bug #1337990: clarified that ``doctest`` does not support examples
requiring both expected output and an exception.

Doc/lib/libdoctest.tex
Misc/NEWS

index f5560f56451566b7ef8925747999fa4459d91478..f837d7facc090a59039555b18fd0d515c697ce41 100644 (file)
@@ -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:
 
index d25638583f252f69d0a8f1abe7837981fa33a34e..f647d1f405015214e7b47f3bde09a46f79c81279 100644 (file)
--- a/Misc/NEWS
+++ b/Misc/NEWS
@@ -54,6 +54,12 @@ Build
 
 - Fix test_long failure on Tru64 with gcc by using -mieee gcc option.
 
+Documentation
+-------------
+
+- Bug #1337990: clarified that ``doctest`` does not support examples
+  requiring both expected output and an exception.
+
 
 What's New in Python 2.4.3?
 ===========================