pytools.api.doc.HasWellFormedDocstring#

class pytools.api.doc.HasWellFormedDocstring[source]#

Check if the given element has a well-formed docstring.

Method summary

Test the given definition.

Definitions

test(definition)[source]#

Test the given definition.

Parameters: definition (APIDefinition) – the definition to test
Return type: Union[None, str, list[str]]
Returns: an error test or list of error texts if the definition failed; None or an empty list if successful

pytools.api.doc.HasTypeHints

pytools.api.doc.ModuleDefinition