Add rst-directive-space check
#134
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
oscargus
force-pushed
the
rst-space
branch
2 times, most recently
from
240bf0b
to
83f55a4
Compare
asottile
reviewed
Jan 10, 2023
.pre-commit-hooks.yaml
Outdated
Comment on lines
68
to
67
| - id: rst-directive-space | ||
| name: rst directives space before two colons | ||
| description: 'Detect mistake of additional space in rst directive' | ||
| entry: '^\s*\.\. [a-z]+ ::$' | ||
| language: pygrep | ||
| types: [rst] |
There was a problem hiding this comment.
this can probably get bundled in with the other rst check?
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.
Another reasonably common mistake, e.g. matplotlib/matplotlib#24927 is to put a space before the double colon.
Ideally one should check for the combination of space and single colon, but not clear if it is better to merge this check with a more complicated regex for test-directive-colons or modify this to check for both (or keep it as is).
(Also, this will not catch matplotlib/matplotlib#24927 as it is in a py and a c++-file, but for consistency with the other rst-tests...)