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

Add docstrings to functions #587

Open
1 task
machawk1 opened this issue Feb 11, 2025 · 0 comments
Open
1 task

Add docstrings to functions #587

machawk1 opened this issue Feb 11, 2025 · 0 comments
Labels
Documentation Project Quality 🤌

Comments

@machawk1
Copy link
Owner

machawk1 commented Feb 11, 2025 •
edited
Loading

interrogate can help with this, e.g., interrogate -vv bundledApps/WAIL.py shows about 26% coverage of the functions with respect to having docstrings. This is easily fixable. Then again there is the argument of self-documenting code...

https://www.b-list.org/weblog/2022/dec/19/boring-python-code-quality/ has some other suggestions inclusive of recommending Sphinx.

  • Set up interrogate as a pre-commit hook
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Documentation Project Quality 🤌
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@machawk1