[Python-checkins] r61759 - doctools/trunk/doc/ext/doctest.rst

[georg.brandl]

Author: georg.brandl
Date: Sat Mar 22 21:47:27 2008
New Revision: 61759

Modified:
   doctools/trunk/doc/ext/doctest.rst
Log:
Add note about blank lines in doctest blocks.


Modified: doctools/trunk/doc/ext/doctest.rst
==============================================================================
--- doctools/trunk/doc/ext/doctest.rst	(original)
+++ doctools/trunk/doc/ext/doctest.rst	Sat Mar 22 21:47:27 2008
@@ -157,12 +157,12 @@
    recognizes it from the leading ``>>>``.  Also, no additional indentation is
    necessary, though it doesn't hurt.)
 
-   If this value is true, the above snippet is interpreted by the doctest
-   builder exactly like the following::
+   If this value is left at its default value, the above snippet is interpreted
+   by the doctest builder exactly like the following::
 
       Some documentation text.
 
-      .. doctest:: doctest_block
+      .. doctest::
 
          >>> print 1
          1
@@ -172,3 +172,6 @@
    This feature makes it easy for you to test doctests in docstrings included
    with the :mod:`~sphinx.ext.autodoc` extension without marking them up with a
    special directive.
+
+   Note though that you can't have blank lines in reST doctest blocks.  They
+   will be interpreted as one block ending and another one starting.