chore: add comment formatting pre-commit hook script #1126
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
Signed-off-by: Ben Selwyn-Smith <benselwynsmith@googlemail.com>
Signed-off-by: Ben Selwyn-Smith <benselwynsmith@googlemail.com>
Signed-off-by: Ben Selwyn-Smith <benselwynsmith@googlemail.com>
Signed-off-by: Ben Selwyn-Smith <benselwynsmith@googlemail.com>
Signed-off-by: Ben Selwyn-Smith <benselwynsmith@googlemail.com>
oracle-contributor-agreement
bot
added
the
OCA Verified
Signed-off-by: Ben Selwyn-Smith <benselwynsmith@googlemail.com>
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
This PR adds a new pre-commit hook that checks the grammar/formatting of Python comments.
Description of changes
The script attempts to correct comments so that they start with a capital letter and end with a full stop where applicable. This is achieved by examination of the space tokenised contents of each comment.
As implemented, the new hook checks any Python source files that were changed and reside within the
src/macaronortestsdirectories. All source files that could be changed by this script have been modified and included as part of this PR. Some files were manually edited to overcome script limitations, or to be excluded from checking entirely.Information on working with the script (including disabling it for certain files) has been added to the style guide.