Skip to content
This repository has been archived by the owner on Dec 16, 2022. It is now read-only.

Ability to enforce package and module level docstrings #201

Open
danhje opened this issue Apr 30, 2022 · 0 comments
Open

Ability to enforce package and module level docstrings #201

danhje opened this issue Apr 30, 2022 · 0 comments

Comments

@danhje
Copy link

danhje commented Apr 30, 2022

From PEP-257:

"The docstring for a module should generally list the classes, exceptions and functions (and any other objects) that are exported by the module, with a one-line summary of each. (These summaries generally give less detail than the summary line in the object’s docstring.) The docstring for a package (i.e., the docstring of the package’s init.py module) should also list the modules and subpackages exported by the package."

I would really appreciate the ability to enforce the existence of package- and module level docstrings. Checking these docstrings against the content of the package / module is not necessary for this feature to be useful.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant