Skip to content

[New Rule] Implement sniff for classes and interfaces PHPDoc formatting #105

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
lenaorobei opened this issue May 31, 2019 · 2 comments
Closed
Labels
accepted New rule is accepted new rule New feature implementation Progress: good first issue Issues is easy to get started with

Comments

@lenaorobei
Copy link
Contributor

lenaorobei commented May 31, 2019

Rule

PHPDoc formatting for classes and interfaces.

Acceptance Criteria:

Classes and interfaces should have a short description that is a human-understandable intention of the class.
If the short description adds no additional information beyond what the type name already supplies, the short description must be omitted.

  • Rule covered by unit test.
<severity>5</severity>
<type>warning</type>
@lenaorobei lenaorobei added enhancement Improvements to existing rules accepted New rule is accepted new rule New feature implementation Progress: good first issue Issues is easy to get started with and removed enhancement Improvements to existing rules labels May 31, 2019
@lenaorobei lenaorobei changed the title [New Rule] Implement sniff for class PHPDoc formatting [New Rule] Implement sniff for classes and interfaces PHPDoc formatting May 31, 2019
@lenaorobei
Copy link
Contributor Author

Hi @udovicic! How is your progress with this ticket? Do you need any help?

@udovicic
Copy link
Member

udovicic commented Aug 1, 2019

Hi @lenaorobei , help no, but more hours in one day definitely. I think I will be done be the end of the week.

udovicic added a commit to udovicic/magento-coding-standard that referenced this issue Aug 3, 2019
udovicic added a commit to udovicic/magento-coding-standard that referenced this issue Aug 3, 2019
udovicic added a commit to udovicic/magento-coding-standard that referenced this issue Aug 7, 2019
udovicic added a commit to udovicic/magento-coding-standard that referenced this issue Aug 10, 2019
udovicic added a commit to udovicic/magento-coding-standard that referenced this issue Aug 10, 2019
lenaorobei added a commit to udovicic/magento-coding-standard that referenced this issue Aug 12, 2019
lenaorobei added a commit that referenced this issue Aug 12, 2019
magento-devops-reposync-svc pushed a commit that referenced this issue Oct 27, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
accepted New rule is accepted new rule New feature implementation Progress: good first issue Issues is easy to get started with
Projects
None yet
Development

No branches or pull requests

2 participants