pymc icon indicating copy to clipboard operation
pymc copied to clipboard

Docs to numpydoc convention

Open ColCarroll opened this issue 6 years ago • 2 comments

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:

  1. fix one directory at a time: use python -m pydocstyle --convention=numpy pymc3/path/to/directory/ and do what the suggestions say
  2. add python -m pydocstyle --convention=numpy pymc3/path/to/directory/ to pymc3/scripts/lint.sh
  3. make a PR
  4. repeat.

ColCarroll avatar Dec 06 '19 23:12 ColCarroll

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?

eigenfoo avatar Dec 07 '19 00:12 eigenfoo

When the roadmap is clear, I'd like to help with this one.

michaelosthege avatar Dec 21 '19 14:12 michaelosthege

@OriolAbril Is this issue still relevant?

ricardoV94 avatar Sep 30 '22 11:09 ricardoV94

probably yes, hopefully we don't have that many errors now though.

OriolAbril avatar Sep 30 '22 17:09 OriolAbril

Closing in favor of #6378

ricardoV94 avatar Dec 08 '22 12:12 ricardoV94