Trim trailing whitespaces and update pre-commit config to include "trailing-whitespace"#7332
Merged
jcfr merged 2 commits intoSlicer:mainfrom Nov 2, 2023
Conversation
Consistently avoiding trailing whitespaces is helpful to avoid "false differences" and ensure all diffing tools show the "real" changes by default.
By adding `trailing-whitespace` to the pre-commit configuration, it enables the following: * GitHub Action report: Suggested changes are reported in the error log associated with the pre-commit GitHub Action workflow. * Consolidated local pre-commit checks and updates by running: ``` PythonSlicer -m pip install pyupgrade PythonSlicer -m pre_commit run --all-files ```
jamesobutler
approved these changes
Nov 1, 2023
Contributor
jamesobutler
left a comment
There was a problem hiding this comment.
My group uses this trailing whitespace check in our own work with success. Adding it here makes sense.
For additional reference we also use - id: check-ast
Member
Author
|
Thanks for the feedback. I will gradually introduce new checks. |
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
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.
Consistently avoiding trailing whitespaces is helpful to avoid "false differences" and ensure all diffing tools show the "real" changes by default.
By adding
trailing-whitespaceto the pre-commit configuration, it enables the following:GitHub Action report: Suggested changes are reported in the error log associated with the pre-commit GitHub Action workflow.
Consolidated local pre-commit checks and updates by running:
Once this is integrated we will add the commit
STYLE: Trim trailing whitespacesto.git-blame-ignore-revs1 as it was one:Footnotes
https://github.com/Slicer/Slicer/blob/main/.git-blame-ignore-revs ↩