search

LSSTDESC / rail

Top level "umbrella" package for RAIL
MIT License
8 stars 4 forks source link

clean up docstrings #22

Closed eacharles closed 9 months ago

eacharles commented 2 years ago

https://lsstdescrail.readthedocs.io/en/latest/api.html

drewoldag commented 1 year ago

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.

drewoldag commented 1 year ago

@delucchi-cmu can you find the tool to automatically flag docstring problems?

delucchi-cmu commented 1 year ago

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. docstring_findings.csv