This repository has been archived by the owner on Nov 3, 2023. It is now read-only.
Consider uppercase docstring prefixes at D300. #176
Merged
Conversation
This file contains 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
toroettg
force-pushed
the
D300UppercaseStringprefix
branch
from
3f89104 to
34aa554
Compare
|
This looks good to me. Seems reasonable too. |
| @@ -4,6 +4,12 @@ Release Notes | |||
| **pydocstyle** version numbers follow the | |||
| `Semantic Versioning <http://semver.org/>`_ specification. | |||
|
|
|||
| x.x.x - unknown date | |||
There was a problem hiding this comment.
Instead write "Current Development Version".
|
Looks good. Just fix the small comment I made in the docs and I'll merge this. |
toroettg
force-pushed
the
D300UppercaseStringprefix
branch
from
34aa554 to
a29eeeb
Compare
|
Gladly done! |
|
Still looks good to me. I think @Nurdok wanted that entire line replaced with "Current development version" but |
|
That is what I meant, but I'll just change this manually right after this merge. |
Nurdok
added a commit
that referenced
this pull request
Mar 2, 2016
Consider uppercase docstring prefixes at D300.
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.
While PEP 257 suggests to use lowercase literals, Python allows uppercase literals as string prefixes.
Unlike D301 and 302, error code D300 is not reported if uppercase docstring prefixes are being used (e.g.,
R'''...'''). The current implementation of D300 also causes a false positive for uppercase literals with double quotes (e.g.,R"""Sum\\mary."""), and detects the quotes incorrectly for aur'''...'''docstring prefix.This proposes a more robust implementation for D300 and adds some uppercase tests for D301 and
D302, which they already pass.EDIT: For the sake of simplicity, the D302 uppercase literal test will be included in another PR.