23.2.3.1 Which Docstrings Are Examined?
The module docstring, and all function, class and method docstrings are
searched. Objects imported into the module are not searched.
In addition, if M.__test__ exists and "is true", it must be a
dict, and each entry maps a (string) name to a function object, class
object, or string. Function and class object docstrings found from
M.__test__ are searched, and strings are treated as if they
were docstrings. In output, a key K in M.__test__ appears
with name
Any classes found are recursively searched similarly, to test docstrings in
their contained methods and nested classes.
Changed in version 2.4:
A "private name" concept is deprecated and no longer
documented.
Release 2.5.2, documentation updated on 21st February, 2008.
See About this document... for information on suggesting changes.
|