diff options
Diffstat (limited to 'doc/ext/doctest.rst')
| -rw-r--r-- | doc/ext/doctest.rst | 21 |
1 files changed, 11 insertions, 10 deletions
diff --git a/doc/ext/doctest.rst b/doc/ext/doctest.rst index 0c64f17a..20e747de 100644 --- a/doc/ext/doctest.rst +++ b/doc/ext/doctest.rst @@ -39,13 +39,13 @@ interpreted as follows: if it is empty, the block is assigned to the group named ``default`` group). Otherwise, it must be a comma-separated list of group names. -.. directive:: .. testsetup:: [group] +.. rst:directive:: .. testsetup:: [group] A setup code block. This code is not shown in the output for other builders, but executed before the doctests of the group(s) it belongs to. -.. directive:: .. doctest:: [group] +.. rst:directive:: .. doctest:: [group] A doctest-style code block. You can use standard :mod:`doctest` flags for controlling how actual output is compared with what you give as output. By @@ -78,7 +78,7 @@ names. output. -.. directive:: .. testcode:: [group] +.. rst:directive:: .. testcode:: [group] A code block for a code-output-style test. @@ -107,10 +107,10 @@ names. applies to testcode/testoutput as well. -.. directive:: .. testoutput:: [group] +.. rst:directive:: .. testoutput:: [group] The corresponding output, or the exception message, for the last - :dir:`testcode` block. + :rst:dir:`testcode` block. This directive supports two options: @@ -134,7 +134,7 @@ names. The following is an example for the usage of the directives. The test via -:dir:`doctest` and the test via :dir:`testcode` and :dir:`testoutput` are +:rst:dir:`doctest` and the test via :rst:dir:`testcode` and :rst:dir:`testoutput` are equivalent. :: The parrot module @@ -197,9 +197,9 @@ There are also these config values for customizing the doctest extension: Some more documentation text. - (Note that no special ``::`` is needed to introduce the block; docutils - recognizes it from the leading ``>>>``. Also, no additional indentation is - necessary, though it doesn't hurt.) + (Note that no special ``::`` is used to introduce a doctest block; docutils + recognizes them from the leading ``>>>``. Also, no additional indentation is + used, though it doesn't hurt.) If this value is left at its default value, the above snippet is interpreted by the doctest builder exactly like the following:: @@ -220,4 +220,5 @@ There are also these config values for customizing the doctest extension: 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. Also, removal of ``<BLANKLINE>`` and ``# doctest:`` options only works in - :dir:`doctest` blocks. + :rst:dir:`doctest` blocks, though you may set :confval:`trim_doctest_flags` to + achieve the latter in all code blocks with Python console content. |