Skip to content

Module docstrings #8

@jdkandersson

Description

@jdkandersson

Pep257 discusses documenting functions, classes and other objects exported from a module should be documented in the module docstring. Add a linter that checks this:

# module.py

"""...

Functions:
    foo: ...

Classes:
    FooClass: ...

Constants:
    FOO: ...
"""

FOO = ...

def foo(): ...

class FooClass: ...

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