Skip to content
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

Automatically remove useless comments #433

Conversation

fredden
Copy link
Member

@fredden fredden commented Jan 26, 2023

When issues are detected and classified as Magento2.Commenting.ClassAndInterfacePHPDocFormatting.ForbiddenTags or Magento2.Commenting.ClassAndInterfacePHPDocFormatting.InvalidDescription, these can be fixed by removing the offending comment.

When issues are detected and classified as
Magento2.Commenting.ClassAndInterfacePHPDocFormatting.ForbiddenTags or
Magento2.Commenting.ClassAndInterfacePHPDocFormatting.InvalidDescription,
these can be fixed by removing the offending comment.
@sinhaparul
Copy link
Contributor

@magento import PR to magento-commerce/magento-coding-standard repository

@m2-github-services
Copy link
Contributor

@sinhaparul the Pull Request is successfully imported.

@sidolov
Copy link
Collaborator

sidolov commented Sep 26, 2023

@magento import PR to magento-commerce/magento-coding-standard repository

@m2-github-services
Copy link
Contributor

@sidolov the Pull Request is successfully imported.

@magento-devops-reposync-svc magento-devops-reposync-svc merged commit d1711ba into magento:develop Sep 26, 2023
@fredden fredden deleted the auto-fix/remove-useless-comments branch September 26, 2023 15:24
@orlangur
Copy link

Magento2.Commenting.ClassAndInterfacePHPDocFormatting.InvalidDescription

Well, the whole point of this sniff was to enforce meaningful descriptions :)
Invalid description removal goes against this.

@ihor-sviziev
Copy link
Collaborator

ihor-sviziev commented Oct 15, 2024

@orlangur, from the message:

description must contain meaningful information beyond what its name provides or be removed.

So it does make sense to auto-remove it
In general, enforcing adding a description for self-descriptive method/class is a bad idea

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Development

Successfully merging this pull request may close these issues.

7 participants