New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add public functions to class docstring #7

Open

jdkandersson opened this issue Jan 7, 2023 · 1 comment

Owner

jdkandersson commented Jan 7, 2023 •

edited

Loading

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

Owner Author

jdkandersson commented Jan 7, 2023

Maybe also support Funcs shorthand?

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