Skip to content
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

Extend support for detecting missing arguments in Numpy style docstrings #407

Merged
merged 5 commits into from Oct 23, 2019

Conversation

@samj1912
Copy link
Contributor

samj1912 commented Sep 21, 2019

Thanks for submitting a PR!

Please make sure to check for the following items:

  • Add unit tests and integration tests where applicable.
    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 add
    it 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.
  • Add a line to the release notes (docs/release_notes.rst) under "Current Development Version".
    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.

@samj1912 samj1912 force-pushed the samj1912:numpy-arg-check branch 2 times, most recently from 1e1aec5 to b0248e7 Sep 21, 2019
@samj1912

This comment has been minimized.

Copy link
Contributor Author

samj1912 commented Sep 21, 2019

@Nurdok review please :)

@samj1912 samj1912 changed the title Numpy arg check Extend support for detecting missing arguments in Numpy style docstrings Sep 21, 2019
@samj1912 samj1912 force-pushed the samj1912:numpy-arg-check branch from ed5c52a to 82d3fb3 Sep 21, 2019
@samj1912

This comment has been minimized.

Copy link
Contributor Author

samj1912 commented Sep 28, 2019

@Nurdok ping.

src/pydocstyle/checker.py Outdated Show resolved Hide resolved
docs/release_notes.rst Outdated Show resolved Hide resolved
src/pydocstyle/violations.py Show resolved Hide resolved
@samj1912 samj1912 force-pushed the samj1912:numpy-arg-check branch 2 times, most recently from 24e263a to 30c5d33 Oct 13, 2019
@samj1912

This comment has been minimized.

Copy link
Contributor Author

samj1912 commented Oct 13, 2019

@Nurdok addressed comments :)

@samj1912 samj1912 requested a review from Nurdok Oct 13, 2019
@samj1912 samj1912 force-pushed the samj1912:numpy-arg-check branch from 30c5d33 to d3710ee Oct 13, 2019
@samj1912

This comment has been minimized.

Copy link
Contributor Author

samj1912 commented Oct 16, 2019

@Nurdok ping

@Nurdok

This comment has been minimized.

Copy link
Member

Nurdok commented Oct 21, 2019

Thanks for this @samj1912. Sorry for the delayed response, I've been out on a family vacation. Please update branch so I can merge.

@samj1912

This comment has been minimized.

Copy link
Contributor Author

samj1912 commented Oct 21, 2019

@Nurdok done

samj1912 added 4 commits Sep 21, 2019
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 #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.
@samj1912 samj1912 force-pushed the samj1912:numpy-arg-check branch from 4aa5433 to 966d42a Oct 21, 2019
@Nurdok
Nurdok approved these changes Oct 23, 2019
@Nurdok Nurdok merged commit ecbc0ea into PyCQA:master Oct 23, 2019
2 checks passed
2 checks passed
continuous-integration/appveyor/pr AppVeyor build succeeded
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants
You can’t perform that action at this time.