Commits

Anonymous committed 1c0353d

Add note about blank lines in doctest blocks.

Comments (0)

Files changed (1)

doc/ext/doctest.rst

    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
    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.