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.

Sign up for GitHub

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

Jump to bottom

Ensure full method docstring coverage #25

Open
russelldj opened this issue Nov 7, 2023 · 2 comments
Open

Ensure full method docstring coverage #25

russelldj opened this issue Nov 7, 2023 · 2 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@russelldj
Copy link
Collaborator

I've gotten lazy with some recent PRs and haven't made sure all the functions/methods have docstrings. This should be addressed. A lower-priority task would be ensuring that all docstrings are up to date and reflect the current arguments. I personally use VSCode autoDocstring to do the templating.
@russelldj russelldj added the documentation Improvements or additions to documentation label Nov 7, 2023
@russelldj russelldj added the good first issue Good for newcomers label Jan 23, 2024
@russelldj
Copy link
Collaborator Author

It might be useful to explore pydoctest as a way to help with this.

@russelldj
Copy link
Collaborator Author

It would be useful for the docs pages to have some more summary content. We should look into whether there are more opportunities to include this in the actual files (e.g. can you have a file-level docstring?) and if not include it in the docs folder.

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

No branches or pull requests
1 participant
@russelldj