[Python-checkins] r45677 - in python/trunk: Doc/lib/libdoctest.tex Misc/NEWS

[tim.peters]

Author: tim.peters
Date: Mon Apr 24 04:03:16 2006
New Revision: 45677

Modified:
   python/trunk/Doc/lib/libdoctest.tex
   python/trunk/Misc/NEWS
Log:
Bug #1337990: clarified that `doctest` does not support examples
requiring both expected output and an exception.

I'll backport to 2.4 next.


Modified: python/trunk/Doc/lib/libdoctest.tex
==============================================================================
--- python/trunk/Doc/lib/libdoctest.tex	(original)
+++ python/trunk/Doc/lib/libdoctest.tex	Mon Apr 24 04:03:16 2006
@@ -407,10 +407,13 @@
 \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:
 

Modified: python/trunk/Misc/NEWS
==============================================================================
--- python/trunk/Misc/NEWS	(original)
+++ python/trunk/Misc/NEWS	Mon Apr 24 04:03:16 2006
@@ -171,6 +171,8 @@
 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?