This repository was archived by the owner on Nov 3, 2023. It is now read-only.
Extend support for detecting missing arguments in Numpy style docstrings #407
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sambhav
force-pushed
the
numpy-arg-check
branch
2 times, most recently
from
1e1aec5 to
b0248e7
Compare
|
@Nurdok review please :) |
sambhav
changed the title
sambhav
force-pushed
the
numpy-arg-check
branch
from
ed5c52a to
82d3fb3
Compare
peterjc
reviewed
Sep 23, 2019
|
@Nurdok ping. |
Nurdok
suggested changes
Oct 8, 2019
sambhav
force-pushed
the
numpy-arg-check
branch
2 times, most recently
from
24e263a to
30c5d33
Compare
|
@Nurdok addressed comments :) |
sambhav
force-pushed
the
numpy-arg-check
branch
from
30c5d33 to
d3710ee
Compare
|
@Nurdok ping |
|
Thanks for this @samj1912. Sorry for the delayed response, I've been out on a family vacation. Please update branch so I can merge. |
|
@Nurdok done |
Google docstrings should document their arguments in the Args section not the Parameters section. See http://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings
Fixes PyCQA#394 This adds support for checking missing arguments in Numpy docstrings.
D417 is raised even if that parameter is present in the docstring, but has an empty description.
sambhav
force-pushed
the
numpy-arg-check
branch
from
4aa5433 to
966d42a
Compare
Nurdok
approved these changes
Oct 23, 2019
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Thanks for submitting a PR!
Please make sure to check for the following items:
If you've added an error code or changed an error code behavior,
you should probably add or change a test case file under
tests/test_cases/and addit to the list under
tests/test_definitions.py.If you've added or changed a command line option,
you should probably add or change a test in
tests/test_integration.py.Make sure to include the PR number after you open and get one.
Please don't get discouraged as it may take a while to get a review.