Allow to skip see tag in annotation with specific deprecated comment #419
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
changed the title
sivaschenko
reviewed
Sep 1, 2022
| @@ -123,6 +126,10 @@ public function hasDeprecatedWellFormatted($commentStartPtr, $tokens) | |||
| } | |||
| $seePtr = $this->getTagPosition('@see', $commentStartPtr, $tokens); | |||
| if ($seePtr === -1) { | |||
| if (stripos($tokens[$deprecatedPtr + 2]['content'], self::REMOVED_IN_VERSION, 0) !== false && | |||
There was a problem hiding this comment.
Expected:
@deprecated This method will be removed in version 2.x.x without replacement
Actual:
- @deprecated removed in versionwithout replacement
- @deprecated without replacementremoved in version
There was a problem hiding this comment.
Thanks for the useful comment! I've done a refactor to use preg_match instead
m2-community-project
bot
added
Progress: review
and removed
Progress: ready for review
labels
sivaschenko
approved these changes
Sep 1, 2022
|
@magento import pr to magento-commerce/magento-coding-standard |
|
@sivaschenko the Pull Request is successfully imported. |
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.
For deprecated code with no replacement as that functionality is not provided anymore, use This method will be removed in version 2.x.x without replacement as keyword phrase in @deprecated description in addition to deprecation motif. That keyword phrase will help us identify @deprecated annotations that do not need @see.
https://github.com/magento-commerce/development-guild/issues/191
https://jira.corp.adobe.com/browse/LYNX-32