https://github.com/python/cpython/commit/27a2152a9b976ea09bd6de02f44acef29581bd36 commit: 27a2152a9b976ea09bd6de02f44acef29581bd36 branch: 3.14 author: Miss Islington (bot) <[email protected]> committer: hugovk <[email protected]> date: 2025-08-27T17:01:55+03:00 summary:
[3.14] gh-44538: Mention nested classes/functions in doctest docs (GH-137870) (#137918) Co-authored-by: Bartosz Sławecki <[email protected]> files: M Doc/library/doctest.rst diff --git a/Doc/library/doctest.rst b/Doc/library/doctest.rst index 82e570a2a85cd7..61463d6adcd143 100644 --- a/Doc/library/doctest.rst +++ b/Doc/library/doctest.rst @@ -350,6 +350,13 @@ searches them recursively for docstrings, which are then scanned for tests. Any classes found are recursively searched similarly, to test docstrings in their contained methods and nested classes. +.. note:: + + ``doctest`` can only automatically discover classes and functions that are + defined at the module level or inside other classes. + + Since nested classes and functions only exist when an outer function + is called, they cannot be discovered. Define them outside to make them visible. .. _doctest-finding-examples: _______________________________________________ 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]
