pymc
pymc copied to clipboard
Docs to numpydoc convention
Right now, running
$ python -m pydocstyle --convention=numpy pymc/ | wc -l
3090
Shows 3090.
It would be a bit much to try to fix all this at once, but a helpful contribution would be to:
- fix one directory at a time: use
python -m pydocstyle --convention=numpy pymc3/path/to/directory/and do what the suggestions say - add
python -m pydocstyle --convention=numpy pymc3/path/to/directory/topymc3/scripts/lint.sh - make a PR
- repeat.
I think the reason this issue has been so persistent is because there are quite a few D10X: Missing docstring in X function errors. This is pretty bad because missing docstrings should definitely be failing some test, so should we could agree to fix up the stylistic issues, and allow missing docstrings to fail the lint build?
When the roadmap is clear, I'd like to help with this one.
@OriolAbril Is this issue still relevant?
probably yes, hopefully we don't have that many errors now though.
Closing in favor of #6378