https://github.com/python/cpython/commit/d99d8712253c3affc54cf7f6e71f161dea8347ce
commit: d99d8712253c3affc54cf7f6e71f161dea8347ce
branch: main
author: Serhiy Storchaka <[email protected]>
committer: serhiy-storchaka <[email protected]>
date: 2024-01-06T00:23:16+02:00
summary:
gh-113360: Fix the documentation of module's attribute __test__ (GH-113393)
It can only be a dict since Python 2.4.
files:
M Doc/library/doctest.rst
diff --git a/Doc/library/doctest.rst b/Doc/library/doctest.rst
index 8c28e4478bb70e..e4bb6f5ec958c6 100644
--- a/Doc/library/doctest.rst
+++ b/Doc/library/doctest.rst
@@ -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
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
-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.
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
@@ -944,8 +944,8 @@ and :ref:`doctest-simple-testfile`.
(or module :mod:`__main__` if *m* is not supplied or is ``None``), starting
with
``m.__doc__``.
- Also test examples reachable from dict ``m.__test__``, if it exists and is
not
- ``None``. ``m.__test__`` maps names (strings) to functions, classes and
+ Also test examples reachable from dict ``m.__test__``, if it exists.
+ ``m.__test__`` maps names (strings) to functions, classes and
strings; function and class docstrings are searched for examples; strings
are
searched directly, as if they were docstrings.
_______________________________________________
Python-checkins mailing list -- [email protected]
To unsubscribe send an email to [email protected]
https://mail.python.org/mailman3/lists/python-checkins.python.org/
Member address: [email protected]
