Skip to content
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

Closed
eacharles opened this issue Sep 8, 2022 · 3 comments · Fixed by LSSTDESC/rail_base#75
Closed

clean up docstrings #22

eacharles opened this issue Sep 8, 2022 · 3 comments · Fixed by LSSTDESC/rail_base#75
Assignees
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@eacharles
Copy link
Collaborator

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

@eacharles eacharles added the documentation Improvements or additions to documentation label Sep 8, 2022
@eacharles eacharles mentioned this issue Jun 13, 2023
16 tasks
@aimalz aimalz added the good first issue Good for newcomers label Oct 25, 2022
@drewoldag
Copy link
Contributor

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
Copy link
Contributor

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

@delucchi-cmu
Copy link
Collaborator

delucchi-cmu commented Apr 24, 2023

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants