wail icon indicating copy to clipboard operation
wail copied to clipboard

Add docstrings to functions

Open machawk1 opened this issue 10 months ago • 0 comments

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

machawk1 avatar Feb 11 '25 23:02 machawk1