From: Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Date: Fri, 5 Jan 2024 22:29:14 +0000 (+0100)
Subject: [3.11] gh-113360: Fix the documentation of module's attribute __test__ (GH-113393... 
X-Git-Tag: v3.11.8~186
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=6aa86bdcb240501283d1652ee6c54193b32a63b0;p=thirdparty%2FPython%2Fcpython.git

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

It can only be a dict since Python 2.4.
(cherry picked from commit d99d8712253c3affc54cf7f6e71f161dea8347ce)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
---

diff --git a/Doc/library/doctest.rst b/Doc/library/doctest.rst
index 95e65621c3aa..0724623be69d 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
@@ -942,8 +942,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.