Skip to content

Wrong checking of the short descriptions in the class properties #268

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
andrewbess opened this issue Sep 11, 2021 · 3 comments
Closed

Wrong checking of the short descriptions in the class properties #268

andrewbess opened this issue Sep 11, 2021 · 3 comments
Labels
bug Something isn't working Progress: done

Comments

@andrewbess
Copy link
Contributor

Preconditions

  1. Wrong checking of the short descriptions in the class properties when code sniffer checks old class in Magento using magento-coding-standard v9 (v8 checks it correctly)

wrong-checking

2. Perhaps it is reproduced after https://github.com/magento/magento-coding-standard/commit/146bfb099583f7ee26bbafec66fe6560eab4373a

Steps to reproduce

  1. Install magento-coding-standard v9
  2. Check file that contains properties having diffs between property name and short description (for example https://github.com/magento/magento2/blob/2.4.3/lib/internal/Magento/Framework/View/Design/FileResolution/Fallback/Resolver/Simple.php)

Expected result

expected-result

Actual result

actual-result

@andrewbess andrewbess added the bug Something isn't working label Sep 11, 2021
@m2-assistant
Copy link

m2-assistant bot commented Sep 11, 2021

Hi @andrewbess. Thank you for your report.
To help us process this issue please make sure that you provided sufficient information.

Please, add a comment to assign the issue: @magento I am working on this


@sivaschenko
Copy link
Member

sivaschenko commented Sep 12, 2021

@andrewbess thanks for your feedback! As I can see the short description in the file that was checked (https://github.com/magento/magento2/blob/2.4.3/lib/internal/Magento/Framework/View/Design/Fallback/Rule/Simple.php) does duplicate the property name. Do you have any propositions on how we can improve this sniff?

@andrewbess
Copy link
Contributor Author

The problem has been fixed in #270
Thank you @svera
Waiting for the next release (v10)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working Progress: done
Projects
None yet
Development

No branches or pull requests

2 participants