docassert

This extension checks that functions or classes have not undocumented parameters.

Usage

This extension does nothing but generating warnings if a function or a class documents a misspelled parameter (not in the signature) or if one parameter is missing from the documentation.

In conf.py:

extensions = [ ...
    'sphinx_runpython.docassert',
]

Sphinx outputs some warnings:

WARNING: [docassert] '_init' has undocumented parameters 'translator_class' (in 'example_file.py').

Classes

class sphinx_runpython.docassert.sphinx_docassert_extension.OverrideDocFieldTransformer(replaced)

Overrides one function with assigning it to a method.

Parameters:

replaced – should be DocFieldTransformer.transform