From: Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com> Date: Mon, 18 Aug 2025 15:05:12 +0000 (+0200) Subject: [3.13] gh-44538: Mention nested classes/functions in doctest docs (GH-137870) (GH... X-Git-Tag: v3.13.8~174 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=d1882577a32125870c0bc8030d90221068b6b071;p=thirdparty%2FPython%2Fcpython.git [3.13] gh-44538: Mention nested classes/functions in doctest docs (GH-137870) (GH-137917) gh-44538: Mention nested classes/functions in doctest docs (GH-137870) (cherry picked from commit 138ed6db9f89171983dc32af4e7ad2e73d46a940) Co-authored-by: Bartosz Sławecki --- diff --git a/Doc/library/doctest.rst b/Doc/library/doctest.rst index d1ccfc209815..e6f89ea981ac 100644 --- a/Doc/library/doctest.rst +++ b/Doc/library/doctest.rst @@ -346,6 +346,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: