IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Incorporated feeback on doc for doctest_default_flags (#2471).

Browse Source
This commit is contained in:
taschini 2016-04-21 12:30:39 +02:00
parent 8c1d9cc71c
commit 604b45d44b
1 changed files with 12 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
doc/ext/doctest.rst
View File

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