DOC: clarify guidance on style modifications #19222
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
j-bowhay
approved these changes
Sep 11, 2023
There was a problem hiding this comment.
Thanks @lucascolley, I think this is indeed a better wording
mdhaber
approved these changes
Sep 11, 2023
rgommers
added
the
Documentation
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.
Reference issue
N/A
What does this implement/fix?
Changes "It is recommended to leave existing style issues alone unless they exist in files you are already modifying" to "It is recommended to leave existing style issues alone unless they exist in lines of code you are already modifying".
The clarification from files to lines of code should help to reduce the number of unwanted style modifications in PRs containing functional change (in other parts of the files).
Additional information
This tripped me up recently. After reading it, I assumed that any style corrections were welcome as long as they are in the files you are already modifying, but it now makes sense to me that maintainers do not want to have random style modifications mixed in to diffs.
From Ralf: "Yes, that better communicates it."