PHP 8.0 | PEAR/FunctionComment: prevent false positives with attributes #3396
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
PHP 8.0+ attributes can be placed between a docblock and the function declaration it applies to. The `PEAR.Commenting.FunctionComment` sniff - and by extension the `Squiz.Commenting.FunctionComment` sniff - did not yet take this into account. This would result in a false positive `Missing doc comment for function ... ` error. Resolving that error though, would result in a new `There must be no blank lines after the function comment` error, so the blank line check also needed to be fixed. With the current fix, blank lines between the docblock and the function declaration are still not allowed, but non-blank lines between the two (i.e. lines containing attributes) will be ignored. Only one "no blank lines between" error will be thrown per function declaration.
jrfnl
changed the title
|
Thanks for fixing this |
This pull request was closed.
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.
PHP 8.0+ attributes can be placed between a docblock and the function declaration it applies to.
The
PEAR.Commenting.FunctionCommentsniff - and by extension theSquiz.Commenting.FunctionCommentsniff - did not yet take this into account.This would result in a false positive
Missing doc comment for function ...error.Resolving that error though, would result in a new
There must be no blank lines after the function commenterror, so the blank line check also needed to be fixed.With the current fix, blank lines between the docblock and the function declaration are still not allowed, but non-blank lines between the two (i.e. lines containing attributes) will be ignored.
Only one "no blank lines between" error will be thrown per function declaration.