StrictUnusedVariable: update severity to a warning, and remove suggested fixes to prefix variables with underscores
#2593
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
added 2 commits
June 13, 2023 18:10
Refs #2361. Change the severity to `SUGGESTION`. Remove suggested fixes to prefix unused variables with underscores, but keep the suggested fix which renames used variables prefixed with underscores.
Generate changelog in
|
mpritham
commented
Jun 14, 2023
| @@ -133,63 +133,49 @@ void handles_lambdas_in_static_init() { | |||
|
|
|||
| @Test | |||
| public void renames_previous_suppression() { | |||
| refactoringTestHelper | |||
| .addInputLines( | |||
| // if it is prefixed with 'unused' don't do anything. | |||
There was a problem hiding this comment.
This is not the current functionality, but something I was thinking about. It's could be a bit annoying if we show this warning when the user already acknowledged that the variable is unused by prefixing it with unused or ignored.
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.
Before this PR
The
StrictUnusedVariablecheck currently produces errors when a variable is unused unless it is prefixed with an underscore. There are cases (albeit rare) where users legitimately need to keep a reference to an object in scope to prevent the GC from cleaning it. For these scenarios, the underscore prefix (or a suppression) is introduced to satisfy this check.By moving the severity to the
WARNINGlevel, users will still be alerted of their unused variables, and can decide what action they'd like to take.After this PR
==COMMIT_MSG==
Closes #2361. Change the severity to
WARNING. Remove suggested fixes to prefix unused variables with underscores, but keep the suggested fix which renames used variables prefixed with underscores.==COMMIT_MSG==
Possible downsides?