Skip to content
This repository was archived by the owner on Nov 3, 2023. It is now read-only.

D417 for missing arguments is google only #394

Closed
peterjc opened this issue Aug 5, 2019 · 3 comments
Closed

D417 for missing arguments is google only #394

peterjc opened this issue Aug 5, 2019 · 3 comments

Comments

@peterjc
Copy link
Contributor

peterjc commented Aug 5, 2019

In principle D417 (new in v4.0.0 c02884919e3f3708a1343443b52cb9b69434663c by @samj1912 as part of support for the Google coding style #275, further enhancement in #384 ) could be performed under the numpy convention, which has a well defined parameters section.

In fact, it could be applied to the default pep257 convention with a simple substring check - are all the function arguments present anywhere in the docstring? This wouldn't catch everything but would be better than nothing?

@sambhav
Copy link
Member

sambhav commented Sep 21, 2019

I added support for numpy style docs for now

@peterjc
Copy link
Contributor Author

peterjc commented Sep 21, 2019

Ah, pull request #407 - looks good :)

sambhav added a commit to sambhav/pydocstyle that referenced this issue Oct 21, 2019
Fixes PyCQA#394

This adds support for checking missing arguments in Numpy docstrings.
@Nurdok Nurdok closed this as completed in ecbc0ea Oct 23, 2019
@rademacher-p
Copy link

@samj1912 As suggested by the OP's inclusion of --add-select in #461, it appears that D417 is still excluded when convention=numpy. Same on my end - should this exclusion be removed?

On the same topic, should the exclusion of D413 be removed for NumPy docstrings, as well? Everything I've seen on NumPy docstring style suggests that a blank line before closing the string is standard.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants