Skip to content

Add public functions to class docstring #7

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():
        """..."""

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

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