Java: Document which assignment type is covered by which class #15451
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
aschackmull
added
the
no-change-note-required
aschackmull
approved these changes
Feb 13, 2024
That's certainly a fair point, but I'm not sure the effort involved in terms of judging the need for and handling deprecation, or assessing the impact of a potentially breaking change is worth the gain. |
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.
Resolves #3266 (see discussion there)
This change tries to document the current behavior, reducing some confusion regarding which CodeQL class covers which assignment type.
I assume this requires no change note since these are only documentation changes, is that correct?
However, personally I think maybe
Assignmentshould actually coverUnaryAssignExpr(at least the nameUnaryAssignExprsuggests this). For example if you currently want to check for any assignments to array elements you still have to write custom code for this because as mentionedAssignmentdoes not coverUnaryAssignExpr, and all theVar...classes don't work either because the assignment is not directly on a variable, but instead on anArrayAccess.