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

Merged
merged 5 commits into from
Aug 18, 2025
Merged

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

Changes from 1 commit
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
9 changes: 9 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,15 @@ 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.

.. warning::

Only classes and functions defined at the module level (or inside other
classes) are automatically discovered by ``doctest``.

Classes or functions defined inside functions cannot be discovered,
because their definitions depend on the runtime state of the enclosing
function. To make their doctests discoverable, define them outside of
the enclosing function.

.. _doctest-finding-examples:

Expand Down
Loading