Skip to content

Docs to numpydoc convention #3713

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.

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

Closed
ColCarroll opened this issue Dec 6, 2019 · 5 comments
Closed

Docs to numpydoc convention #3713

ColCarroll opened this issue Dec 6, 2019 · 5 comments
Labels
docs needs info Additional information required

Comments

@ColCarroll
Copy link
Member

ColCarroll commented Dec 6, 2019

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.
@eigenfoo
Copy link
Member

eigenfoo commented Dec 7, 2019

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?

@michaelosthege
Copy link
Member

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

@ricardoV94
Copy link
Member

@OriolAbril Is this issue still relevant?

@OriolAbril
Copy link
Member

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

@ricardoV94 ricardoV94 added needs info Additional information required and removed beginner friendly labels Nov 20, 2022
@ricardoV94
Copy link
Member

Closing in favor of #6378

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs needs info Additional information required
Projects
None yet
Development

No branches or pull requests

6 participants