Skip to content

Methods section is now recognized in NumPy-style docstrings

Compare
Choose a tag to compare
@rsokl rsokl released this 24 Jan 22:06
· 18 commits to master since this release
9c9aa86

Previously, the Methods section in a NumPy-style docstring was not recognized

New behavior:

    class Parent(metaclass=DocInheritMeta(style="numpy_with_merge"))::
        """Parent summary.

        Methods
        -------
        meth
        """
        pass

    class Child(Parent):
        """Child summary.

        Attributes
        ----------
        a: hello
        """
        pass

Child will have the docstring

Child summary.

Attributes
----------
a: hello

Methods
-------
 meth