Stowage/cpython
2
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2026-01-04 14:32:21 +00:00
Code Issues Projects Releases Packages Wiki Activity

gh-44538: Mention nested classes/functions in doctest docs (GH-137870)

Browse source
This commit is contained in:
Bartosz Sławecki 2025-08-18 16:58:23 +02:00 • committed by GitHub
parent 83387e033d
commit 138ed6db9f
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 7 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

7
Doc/library/doctest.rst
View file

@ -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: