cfdm.core.DocstringRewriteMeta


class cfdm.core.DocstringRewriteMeta[source]

Bases: type

Modify docstrings.

Methodology

To do this, we intercede before the class is created and modify the docstrings of the attributes defined on the class.

Inherited methods are also modified. We cannot simply modify the docstrings of inherited methods, because then the parent classes’ methods will have the wrong docstring. Instead, we must actually copy the functions, and then modify the docstring.

Special treatment is given to methods decorated with @property, @staticmethod and @classmethod, as well as user-defined decorations.

New in version (cfdm): 1.8.7.0

Inspection

Methods

mro

Return a type’s method resolution order.

_docstring_special_substitutions

Return the special docstring subtitutions.

_docstring_substitutions

Return the docstring substitutions that apply to methods of the given class.

_docstring_package_depth

Return the package depth, N, for {{package}} docstring substitutions for the given class.

_docstring_method_exclusions

Return the names of methods to exclude from docstring substitutions for the given class.