diff --git a/doc/ext/doctest.rst b/doc/ext/doctest.rst index 482e23ca4..bc5878cf6 100644 --- a/doc/ext/doctest.rst +++ b/doc/ext/doctest.rst @@ -55,10 +55,10 @@ names. .. 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. The default set of flags is specified by the - :confval:`doctest_default_flags` configuration variable. + 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. The + default set of flags is specified by the :confval:`doctest_default_flags` + configuration variable. This directive supports two options: @@ -175,13 +175,14 @@ There are also these config values for customizing the doctest extension: .. confval:: doctest_default_flags - By default, these options are enabled: ``ELLIPSIS`` (allowing you - to put ellipses in the expected output that match anything in the - actual output), ``IGNORE_EXCEPTION_DETAIL`` (everything following - the leftmost colon and any module information in the exception name - is ignored), ``DONT_ACCEPT_TRUE_FOR_1`` (by default, doctest - accepts "True" in the output where "1" is given -- this is a relic - of pre-Python 2.2 times). + By default, these options are enabled: ``ELLIPSIS`` (allowing you to put + ellipses in the expected output that match anything in the actual output), + ``IGNORE_EXCEPTION_DETAIL`` (everything following the leftmost colon and any + module information in the exception name is ignored), + ``DONT_ACCEPT_TRUE_FOR_1`` (by default, doctest accepts "True" in the output + where "1" is given -- this is a relic of pre-Python 2.2 times). + + .. versionadded:: 1.5 .. confval:: doctest_path