Squiz/FunctionComment: bug fix - classnames with underscores truncate the return type #1198
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
… the return type If a return type included a class name containing an underscore, the type would be truncated at the underscore and would not take anything after it into account. Bug introduced in PHPCS 2.8.1 via PR squizlabs/PHP_CodeSniffer 1310 and for some reason never reported... 😳 Fixed now. Includes tests. Fixes 1197
4 tasks
jrfnl
deleted the
feature/1197-squiz-functioncomment-bug-classname-truncated
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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
If a return type included a class name containing an underscore, the type would be truncated at the underscore and would not take anything after it into account.
Bug introduced in PHPCS 2.8.1 via PR squizlabs/PHP_CodeSniffer#1310 and for some reason never reported... 😳
Fixed now.
Includes tests.
Fixes #1197
Suggested changelog entry
Fixed: Squiz.Commenting.FunctionComment: if the return type contained a class name with underscores, the return type would be truncated leading to incorrect results.