jdkandersson / flake8-docstrings-complete

Apache License 2.0
12 stars 3 forks source link

Add public functions to class docstring #7

Open jdkandersson opened 1 year ago

jdkandersson commented 1 year ago

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():
        """..."""
jdkandersson commented 1 year ago

Maybe also support Funcs shorthand?