mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-09-27 02:39:58 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 13

gh-113360: Fix the documentation of module's attribute __test__ (GH-113393)

Browse source 
It can only be a dict since Python 2.4.
This commit is contained in:
Serhiy Storchaka 2024-01-06 00:23:16 +02:00 • committed by GitHub
parent bd754b93ca
commit d99d871225
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

6
Doc/library/doctest.rst
View file

@ -280,7 +280,7 @@ searched. Objects imported into the module are not searched.
In addition, there are cases when you want tests to be part of a module but not part In addition, there are cases when you want tests to be part of a module but not part
of the help text, which requires that the tests not be included in the docstring. of the help text, which requires that the tests not be included in the docstring.
Doctest looks for a module-level variable called ``__test__`` and uses it to locate other Doctest looks for a module-level variable called ``__test__`` and uses it to locate other
tests. If ``M.__test__`` exists and is truthy, it must be a dict, and each tests. If ``M.__test__`` exists, it must be a dict, and each
entry maps a (string) name to a function object, class object, or string. entry maps a (string) name to a function object, class object, or string.
Function and class object docstrings found from ``M.__test__`` are searched, and Function and class object docstrings found from ``M.__test__`` are searched, and
strings are treated as if they were docstrings. In output, a key ``K`` in strings are treated as if they were docstrings. In output, a key ``K`` in
@ -944,8 +944,8 @@ and :ref:`doctest-simple-testfile`.
(or module :mod:`__main__` if *m* is not supplied or is ``None``), starting with (or module :mod:`__main__` if *m* is not supplied or is ``None``), starting with
``m.__doc__``. ``m.__doc__``.
Also test examples reachable from dict ``m.__test__``, if it exists and is not Also test examples reachable from dict ``m.__test__``, if it exists.
``None``. ``m.__test__`` maps names (strings) to functions, classes and ``m.__test__`` maps names (strings) to functions, classes and
strings; function and class docstrings are searched for examples; strings are strings; function and class docstrings are searched for examples; strings are
searched directly, as if they were docstrings. searched directly, as if they were docstrings.