summaryrefslogtreecommitdiffstats
path: root/Doc/library/doctest.rst
diff options
context:
space:
mode:
authorR David Murray <rdmurray@bitdance.com>2014-04-15 00:28:36 (GMT)
committerR David Murray <rdmurray@bitdance.com>2014-04-15 00:28:36 (GMT)
commit1976d9bf6d5525821e1cb005a05acbf55a340dfa (patch)
treee0eb0c501c59ef769da9599aa921ea88dd49cad8 /Doc/library/doctest.rst
parent865d23d1dd58c14d26cdff4ac143fce034cb3686 (diff)
downloadcpython-1976d9bf6d5525821e1cb005a05acbf55a340dfa.zip
cpython-1976d9bf6d5525821e1cb005a05acbf55a340dfa.tar.gz
cpython-1976d9bf6d5525821e1cb005a05acbf55a340dfa.tar.bz2
#15916: if there are no docstrings, make empty suite, not an error.
This makes doctest work like unittest: if the test case is empty, that just means there are zero tests run, it's not an error. The existing behavior was broken, since it only gave an error if there were *no* docstrings, and zero tests run if there were docstrings but none of them contained tests. So this makes it self-consistent as well. Patch by Glenn Jones.
Diffstat (limited to 'Doc/library/doctest.rst')
-rw-r--r--Doc/library/doctest.rst12
1 files changed, 3 insertions, 9 deletions
diff --git a/Doc/library/doctest.rst b/Doc/library/doctest.rst
index 50626e9..fb63fde 100644
--- a/Doc/library/doctest.rst
+++ b/Doc/library/doctest.rst
@@ -1058,15 +1058,9 @@ from text files and modules with doctests:
This function uses the same search technique as :func:`testmod`.
- .. note::
- Unlike :func:`testmod` and :class:`DocTestFinder`, this function raises
- a :exc:`ValueError` if *module* contains no docstrings. You can prevent
- this error by passing a :class:`DocTestFinder` instance as the
- *test_finder* argument with its *exclude_empty* keyword argument set
- to ``False``::
-
- >>> finder = doctest.DocTestFinder(exclude_empty=False)
- >>> suite = doctest.DocTestSuite(test_finder=finder)
+ .. versionchanged:: 3.5
+ :func:`DocTestSuite` returns an empty :class:`unittest.TestSuite` if *module*
+ contains no docstrings instead of raising :exc:`ValueError`.
Under the covers, :func:`DocTestSuite` creates a :class:`unittest.TestSuite` out