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

Add support for methods for Google style arg check #384

Merged
merged 1 commit into from Sep 18, 2019

Conversation

@samj1912
Copy link
Contributor

samj1912 commented Jul 21, 2019

This patch adds support for checking the Args section of
methods.

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.

Closes #275

@samj1912

This comment has been minimized.

Copy link
Contributor Author

samj1912 commented Jul 21, 2019

@Nurdok @shacharoo please review.

The test which is currently failing is because of the master and is fixed by #382

@samj1912 samj1912 force-pushed the samj1912:gstyle-margs branch 5 times, most recently from 3a5dba8 to c998355 Jul 21, 2019
@samj1912 samj1912 force-pushed the samj1912:gstyle-margs branch from c998355 to c07d012 Aug 18, 2019
@samj1912

This comment has been minimized.

Copy link
Contributor Author

samj1912 commented Aug 24, 2019

@Nurdok @shacharoo review please?

@samj1912

This comment has been minimized.

Copy link
Contributor Author

samj1912 commented Aug 31, 2019

@Nurdok ping.

@samj1912

This comment has been minimized.

Copy link
Contributor Author

samj1912 commented Sep 7, 2019

@Nurdok bump.

Copy link
Member

Nurdok left a comment

Sorry for taking so long to review this!

src/pydocstyle/checker.py Outdated Show resolved Hide resolved
src/pydocstyle/checker.py Outdated Show resolved Hide resolved
src/pydocstyle/checker.py Outdated Show resolved Hide resolved
src/pydocstyle/checker.py Outdated Show resolved Hide resolved
src/pydocstyle/checker.py Outdated Show resolved Hide resolved
src/tests/test_cases/expected.py Outdated Show resolved Hide resolved
@samj1912

This comment has been minimized.

Copy link
Contributor Author

samj1912 commented Sep 7, 2019

@Nurdok addressed all the comments :)

@samj1912 samj1912 force-pushed the samj1912:gstyle-margs branch 2 times, most recently from a2bfeb9 to 340332b Sep 7, 2019
Copy link
Member

Nurdok left a comment

One small nit and we're done :)

src/pydocstyle/checker.py Outdated Show resolved Hide resolved
This patch adds support for checking the Args section of
methods.
@samj1912 samj1912 force-pushed the samj1912:gstyle-margs branch from 340332b to cbc558a Sep 7, 2019
@samj1912

This comment has been minimized.

Copy link
Contributor Author

samj1912 commented Sep 7, 2019

@Nurdok might be worth doing a release after this PR is merged :)
My team is very much looking forward to using this.

@samj1912

This comment has been minimized.

Copy link
Contributor Author

samj1912 commented Sep 7, 2019

Also, fyi, the docs still point to 4.0.0 instead of 4.0.1

@samj1912

This comment has been minimized.

Copy link
Contributor Author

samj1912 commented Sep 15, 2019

@Nurdok review pls? :)

@Nurdok
Nurdok approved these changes Sep 18, 2019
@Nurdok

This comment has been minimized.

Copy link
Member

Nurdok commented Sep 18, 2019

Thanks so much, and sorry for the long response times! Merging.

@Nurdok Nurdok merged commit 485888a into PyCQA:master Sep 18, 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
@samj1912 samj1912 deleted the samj1912:gstyle-margs branch Sep 18, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants
You can’t perform that action at this time.