You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository has been archived by the owner on Dec 16, 2022. It is now read-only.
"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.
The text was updated successfully, but these errors were encountered:
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.
The text was updated successfully, but these errors were encountered: