D403: Require capitalizing single word sentence #10776
Merged
+59
−10
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
MichaReiser
commented
Apr 4, 2024
Comment on lines
+79
to
+86
| // Like pydocstyle, we only support ASCII for now. | ||
| for char in first_word.chars().skip(1) { | ||
| if !char.is_ascii_alphabetic() && char != '\'' { | ||
| return; | ||
| } | ||
| } | ||
|
|
There was a problem hiding this comment.
I moved this down to avoid checking all characters of the first word if the character is uppercase anyway.
MichaReiser
force-pushed
the
d403-single-word
branch
from
969cd16 to
ff905f1
Compare
|
charliermarsh
approved these changes
Apr 4, 2024
MichaReiser
force-pushed
the
d403-single-word
branch
from
ec7a11d to
b91593c
Compare
Glyphack
pushed a commit
to Glyphack/ruff
that referenced
this pull request
Apr 12, 2024
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.
Summary
Closes #10775
D403 requires capitalizing the first word in docstrings, but only if the word is all ASCII letters (e.g. not a
.).D403 doesn't enforce capitalizing the first word today if it consists of a single word terminated by a
.because a.is not an ASCII letter.This matches pydocstyles behavior. However, it doesn enforce capitalizing the first word if it isn't terminated with a
.This PR fixes
D403to also flag docstrings that start with a single word terminated with a..Test Plan
Added unit tests