Squiz/FunctionCommentThrowTag: bug fix - jump over attributes #936
Conversation
This file contains hidden or 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
Turns out this sniff was never updated to deal with attributes potentially being between a function declaration and the docblock preceding it, which could lead to false negatives. Fixed now. Includes test.
jrfnl
deleted the
feature/squiz-functioncommentthrowtag-improve-comment-tolerance
branch
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.
Description
Turns out this sniff was never updated to deal with attributes potentially being between a function declaration and the docblock preceding it, which could lead to false negatives.
Fixed now.
Includes test.
Suggested changelog entry
Squiz.Commenting.FunctionCommentThrowTag : sniff would bow out when function has attributes attached leading to false negatives