Fixed wrongly returning error for valid descriptions #270
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
sivaschenko
requested changes
Sep 13, 2021
Member
sivaschenko
left a comment
sivaschenko
left a comment
There was a problem hiding this comment.
Thank you for the fix @svera ! Please see my comments
Magento2/Sniffs/Commenting/ClassPropertyPHPDocFormattingSniff.php
Outdated
Show resolved
Hide resolved
| return; | ||
| } | ||
|
|
||
| if (stripos($tokens[$isShortDescriptionPreviousVar]['content'], $tokens[$string]['content']) !== false) { |
Member
There was a problem hiding this comment.
Please check that $isShortDescriptionPreviousVar is not false before using it as an array key
Magento2/Sniffs/Commenting/ClassPropertyPHPDocFormattingSniff.php
Outdated
Show resolved
Hide resolved
m2-community-project
bot
added
Progress: changes requested
and removed
Progress: ready for review
labels
Co-authored-by: Sergii Ivashchenko <serg.ivashchenko@gmail.com>
Co-authored-by: Sergii Ivashchenko <serg.ivashchenko@gmail.com>
sivaschenko
approved these changes
Sep 14, 2021
m2-community-project
bot
added
Progress: approved
and removed
Progress: changes requested
labels
Contributor
Author
|
@magento import pr to magento-commerce/magento-coding-standard |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
#140 was wrongly returning error for valid short descriptions. We added several unit tests checking for this issue, as well as not allowing to repeat property class name in short description and rephrasing the error return when a short description is placed after a @var annotation.