summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorZachary Ware <zachary.ware@gmail.com>2013-11-24 07:19:09 (GMT)
committerZachary Ware <zachary.ware@gmail.com>2013-11-24 07:19:09 (GMT)
commita4b7a7548c43d1d7f4fd52129aa32340ca15af6a (patch)
tree9993a71599cca9dcfbb51dc3286cbb5ab094b455 /Doc
parent091167c1ca513d74c7a146d6a527e7b8b07ae7e8 (diff)
downloadcpython-a4b7a7548c43d1d7f4fd52129aa32340ca15af6a.zip
cpython-a4b7a7548c43d1d7f4fd52129aa32340ca15af6a.tar.gz
cpython-a4b7a7548c43d1d7f4fd52129aa32340ca15af6a.tar.bz2
Issue #3158: doctest can now find doctests in functions and methods
written in C. As a part of this, a few doctests have been added to the builtins module (on hex(), oct(), and bin()), a doctest has been fixed (hopefully on all platforms) on float, and test_builtins now runs doctests in builtins.
Diffstat (limited to 'Doc')
-rw-r--r--Doc/library/doctest.rst9
1 files changed, 6 insertions, 3 deletions
diff --git a/Doc/library/doctest.rst b/Doc/library/doctest.rst
index 6138e30..28df49c 100644
--- a/Doc/library/doctest.rst
+++ b/Doc/library/doctest.rst
@@ -278,6 +278,10 @@ strings are treated as if they were docstrings. In output, a key ``K`` in
Any classes found are recursively searched similarly, to test docstrings in
their contained methods and nested classes.
+.. impl-detail::
+ Prior to version 3.4, extension modules written in C were not fully
+ searched by doctest.
+
.. _doctest-finding-examples:
@@ -1285,9 +1289,8 @@ DocTestFinder objects
A processing class used to extract the :class:`DocTest`\ s that are relevant to
a given object, from its docstring and the docstrings of its contained objects.
- :class:`DocTest`\ s can currently be extracted from the following object types:
- modules, functions, classes, methods, staticmethods, classmethods, and
- properties.
+ :class:`DocTest`\ s can be extracted from modules, classes, functions,
+ methods, staticmethods, classmethods, and properties.
The optional argument *verbose* can be used to display the objects searched by
the finder. It defaults to ``False`` (no output).