Squiz/FunctionSpacing: fix regression - only look at first docblock #946
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
To determine whether there are the correct number of lines before the function declaration, the sniff skips over attributes and docblocks to find the first bit of code which doesn't belong with the function declaration. While the change in PR 826 improved this for attributes _before_ the docblock, it didn't take multiple docblocks into account and would skip over more than just the first docblock. Fixed now. Includes tests.
4 tasks
rodrigoprimo
approved these changes
Apr 9, 2025
jrfnl
deleted the
feature/945-squiz-functionspacing-bug-fix-double-docblock
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
To determine whether there are the correct number of lines before the function declaration, the sniff skips over attributes and docblocks to find the first bit of code which doesn't belong with the function declaration.
While the change in PR #826 improved this for attributes before the docblock, it didn't take multiple docblocks into account and would skip over more than just the first docblock.
Fixed now.
Includes tests.
Suggested changelog entry
Fixed: Squiz.WhiteSpace.FunctionSpacing would get confused when there are two docblocks above a function declaration.
Related issues/external references
Fixes #826
Fixes #945
Closes #938
Types of changes