From fa28e9c70add95df86f27ade87c872ad1c89f924 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bartosz=20S=C5=82awecki?= Date: Mon, 18 Aug 2025 16:58:23 +0200 Subject: [PATCH] gh-44538: Mention nested classes/functions in doctest docs (GH-137870) (cherry picked from commit 138ed6db9f89171983dc32af4e7ad2e73d46a940) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Bartosz Sławecki --- Doc/library/doctest.rst | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/Doc/library/doctest.rst b/Doc/library/doctest.rst index d1ccfc20981523..e6f89ea981acd8 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: