Join GitHub today
GitHub is home to over 50 million developers working together to host and review code, manage projects, and build software together.
Sign upAdd docstrings to everything #109
Open
Labels
Comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
You can do:
pip install pydocstyle
and then run this script while in the
pyt
directoryIt'll spit out which functions don't have docstrings or complain about something non-PEP 257 compliant.
This is a great way to learn the codebase, and everyone will love you for it.
The imports code for example does not have docstrings, for example.
For an example of great docstrings, see the user-defined function calls code.
Afterwards, we can maybe add it as a pre-commit hook.