-
Notifications
You must be signed in to change notification settings - Fork 2
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.
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
Module docstrings #8
Comments
Maybe support abbreviation |
And also support |
Private constants, functions and classes would be optional, indicated by a leading |
Documenting constants would also be optional since many constants's name could be enough documentation for them |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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:
The text was updated successfully, but these errors were encountered: