New pre commit check for release note bullet point format #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
robertapplin
requested changes
Oct 24, 2023
| for filename in filenames: | ||
| with open(filename, 'r') as rn: | ||
| lines = rn.readlines() | ||
| for i in range(len(lines)): |
There was a problem hiding this comment.
Is it possible to avoid using a range-based for loop by just iterating through each element in the list?
There was a problem hiding this comment.
I think I wanted the index so I could change the value in the list on line 32.
Signed-off-by: mantid-builder <mantid-builder@hosting.com>
Signed-off-by: mantid-builder <mantid-builder@hosting.com>
robertapplin
approved these changes
Oct 24, 2023
There was a problem hiding this comment.
The changes look good and have already been tested from @jhaigh0 's repo. Out of interest, what are the windows and darwin clang executables for?
Those commits were added by the pre commit checks which ran. |
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.
Required for mantidproject/mantid#36202
When mantid combines release notes into larger grouped files, if release notes have mismatched bullet point styles (
-vs*for example) when sphinx will give a warning and the docs build will fail. Officially Mantid standards say all release note should use a-so this pre commit hook will enforce that.I've added some unit tests to go along side any manual testing.
This is all pretty much lifted from the repo I made here thinking that we didn't have one already...