Docs: add note and example for extending the range of fix (refs #13706) #13748
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.
Prerequisites checklist
What is the purpose of this pull request? (put an "X" next to an item)
[X] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[ ] Add autofixing to a rule
[ ] Add a CLI option
[ ] Add something to the core
[] Other, please explain:
refs #13706
This PR adds a note about extending the range of a fix in the
working-with-rules
document, and an example based on #13706 (comment).This PR also adds tests to confirm and ensure that empty insertions around a surrounding range can be used to extend fix to that range, per the example.
This is useful if a rule needs to prevent other fixes in the surrounding range in the same pass.
What changes did you make? (Give an overview)
Updated
working-with-rules.md
and added the tests.Is there anything you'd like reviewers to focus on?