Skip to content

Add public functions to class docstring #7

@jdkandersson

Description

@jdkandersson

PEP257 indicates that public functions/ methods of a class should be documented in the class docstring. Add a check for that similar to attrs:

class FooClass:
    """...

    Functions:
        foo: ...
    """

    def foo():
        """..."""

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions