Fix VariableWrong false positives for partial doc blocks #40
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.
Summary
The
VariableWrongcheck inDocBlockParamSniffwas producing false positives when a doc block only documented some parameters (e.g., only those needing complex type hints likearray<string>).Problem
Given this code:
The sniff would report:
This happened because params were compared by position (1st doc block param vs 1st method param) rather than by name.
Solution
Match doc block params to method params by variable name instead of position. This allows:
Test case
Previously: Error (false positive)
Now: No error (correct -
$linesexists in method signature)🤖 Generated with Claude Code