Skip to content

griffe_inherited_docstrings ¤

Griffe Inherited Docstrings package.

Griffe extension for inheriting docstrings.

Modules:

Classes:

InheritDocstringsExtension ¤

Bases: Extension

Griffe extension for inheriting docstrings.

Methods:

  • on_package_loaded

    Inherit docstrings from parent classes once the whole package is loaded.

on_package_loaded ¤

on_package_loaded(*, pkg: Module) -> None

Inherit docstrings from parent classes once the whole package is loaded.

Source code in src/griffe_inherited_docstrings/extension.py
43
44
45
def on_package_loaded(self, *, pkg: Module) -> None:
    """Inherit docstrings from parent classes once the whole package is loaded."""
    _inherit_docstrings(pkg)