-
Notifications
You must be signed in to change notification settings - Fork 156
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
@author MUST NOT be used. #167
Comments
@arushibansal013 I have created a PR (#204) that adds the ability to use |
Hi @arushibansal013 @fredden, |
It looks like the rule was introduced here: magento/devdocs@4165be8 |
I believe all the mentioned tags must not exist in the Magento core, but it should be allowed for the custom extensions. Am I right, @Vinai @sivaschenko ? What I mean - we should move this rule to the following rule set https://github.com/magento/magento-coding-standard/blob/develop/Magento2Framework/ruleset.xml and add what you just suggest editors. Does it make sense? |
Rule
@author MUST NOT be used
Reason
As per magento DocBlock document (https://devdocs.magento.com/guides/v2.3/coding-standards/docblock-standard-general.html#documentation-space)
Structure of documentation space
@author ,@category, @Package, and @subpackage MUST NOT be used. Documentation is organized with the use of namespaces.
Implementation
Need to add @author in $forbiddenTags
The text was updated successfully, but these errors were encountered: