pytools.api.doc#
Tools for validating API documentation including docstrings and type hints.
Classes#
A reference to the definition of an API element, e.g., a module, class, or function. |
|
A test to be run on the documentation of all API elements, including docstrings and type hints. |
|
A reference to a Python function definition. |
|
Test that the definition's docstring exists and is not empty. |
|
Check if parameters match between a callable's signature and its docstring. |
|
Check if the given function is fully type hinted. |
|
Check if the given element has a well-formed docstring. |
|
A reference to a Python module definition. |
|
A reference to a Python class or function definition. |