summaryrefslogtreecommitdiffstats
path: root/Doc/library/doctest.rst
diff options
context:
space:
mode:
authorR David Murray <rdmurray@bitdance.com>2012-11-21 20:09:21 (GMT)
committerR David Murray <rdmurray@bitdance.com>2012-11-21 20:09:21 (GMT)
commit5a9d7061236991f671beb0ac4d298e9b79ce6f10 (patch)
tree13b8a1d0c3876c6bdba6f354fc3ee1e47488769c /Doc/library/doctest.rst
parent90d3352da7094fd8074207cc630cf220ad0ce64e (diff)
downloadcpython-5a9d7061236991f671beb0ac4d298e9b79ce6f10.zip
cpython-5a9d7061236991f671beb0ac4d298e9b79ce6f10.tar.gz
cpython-5a9d7061236991f671beb0ac4d298e9b79ce6f10.tar.bz2
#16522: Add FAIL_FAST flag to doctest.
Patch by me, most of the work (doc and tests) by Daniel Urban.
Diffstat (limited to 'Doc/library/doctest.rst')
-rw-r--r--Doc/library/doctest.rst10
1 files changed, 10 insertions, 0 deletions
diff --git a/Doc/library/doctest.rst b/Doc/library/doctest.rst
index 222c719..8822ef3 100644
--- a/Doc/library/doctest.rst
+++ b/Doc/library/doctest.rst
@@ -633,6 +633,16 @@ The second group of options controls how test failures are reported:
the output is suppressed.
+.. data:: FAIL_FAST
+
+ When specified, exit after the first failing example and don't attempt to run
+ the remaining examples. Thus, the number of failures reported will always be 1.
+ This flag may be useful during debugging, since examples after the first
+ failure won't even produce debugging output.
+
+ .. versionadded:: 3.4
+
+
.. data:: REPORTING_FLAGS
A bitmask or'ing together all the reporting flags above.