-
Notifications
You must be signed in to change notification settings - Fork 3
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
clean up docstrings #22
Comments
Ensure that each of the methods have doc strings that are accurate - not copy/pasted - and render correctly. We should reach out to the owners, this isn't necessarily something we need to write. We should probably try to do this when there aren't a lot of moving parts. |
@delucchi-cmu can you find the tool to automatically flag docstring problems? |
https://www.pydocstyle.org/en/stable/usage.html This tool mostly surfaces formatting issues, but can also find public methods with no docstrings. Attached the findings from the package, cleaned up into a CSV, so you can look by file, or by error code. |
https://lsstdescrail.readthedocs.io/en/latest/api.html
The text was updated successfully, but these errors were encountered: