Skip to content

gh-44538: Mention nested classes/functions in doctest docs #137870

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
+7 −0
Open

gh-44538: Mention nested classes/functions in doctest docs #137870

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
f07862c
Add a warning about nested classes and functions
bswck Aug 17, 2025
25efc38
Use note admonition instead of warning
bswck Aug 17, 2025
20fc71a
Review 1
bswck Aug 17, 2025
479eeae
Review 2
bswck Aug 17, 2025
54cebea
Use clearer language
bswck Aug 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions Doc/library/doctest.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
Loading