Format docstrings in a consistent style #7510
Merged
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
blueyed
reviewed
Jul 17, 2020
src/_pytest/config/argparsing.py
Outdated
| point. | ||
| """ | ||
| """Parses and returns a namespace object with known arguments at this | ||
| point.""" |
There was a problem hiding this comment.
Could/should use imperative mood (also below).
pydocstyle would have caught this.
There was a problem hiding this comment.
Thanks. So I ran pydocstyle now, and fixes issues that came up: 3b6eeda
It does seem useful, if we only include some error codes (unfortunately the imperative mood one has too many false positives). I will probably send a PR to add it, but since it also requires fixes to docstrings in testing/ I will leave it to a separate PR.
bluetech
force-pushed
the
docstrings
branch
2 times, most recently
from
80bc88e to
c9d865a
Compare
nicoddemus
approved these changes
Aug 1, 2020
|
Thanks for reviewing @nicoddemus! As mentioned in a comment above, a followup adding pydocstyle is coming. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR updates the docstrings (and some comments) in
src/to use a more consistent style as discussed in #7471.The second commit documents this in CONTRIBUTING.rst.
The diff is very large and probably pretty boring to review in full, but you can sample it to get the idea. I tried not to make any material changes to the text, but sometimes couldn't resist some very minor improvements.
Fixes #7471. (@aklajnert suggestion to use sphinx-autodoc-typehints will come up in a future PR if it goes well)