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

@author MUST NOT be used. #167

Closed
arushibansal013 opened this issue Jan 9, 2020 · 4 comments · Fixed by #382
Closed

@author MUST NOT be used. #167

arushibansal013 opened this issue Jan 9, 2020 · 4 comments · Fixed by #382

Comments

@arushibansal013
Copy link

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

@arushibansal013 arushibansal013 added the proposal New rule proposal label Jan 9, 2020
@m2-community-project m2-community-project bot added this to Ready for Grooming in Backlog Jan 9, 2020
@arushibansal013 arushibansal013 self-assigned this Jan 9, 2020
@m2-community-project m2-community-project bot moved this from Ready for Grooming to Dev In Progress in Backlog Jan 9, 2020
@cjnewbs
Copy link

cjnewbs commented May 17, 2021

@arushibansal013 I have created a PR (#204) that adds the ability to use phpcbf to remove automatically. Is it worth me adding @author in the same PR?

@m2-community-project m2-community-project bot moved this from Dev In Progress to Pull Request In Progress in Backlog Apr 5, 2022
@ihor-sviziev
Copy link
Collaborator

ihor-sviziev commented Jun 13, 2022

Hi @arushibansal013 @fredden,
Could you please explain why shouldn't we allow using the @author tag in the coding standards?
As for me - it might be relevant only to Magento / Adobe Commerce core but not relevant for all custom extensions.

@fredden
Copy link
Member

fredden commented Jun 13, 2022

It looks like the rule was introduced here: magento/devdocs@4165be8

@ihor-sviziev
Copy link
Collaborator

ihor-sviziev commented Jun 14, 2022

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?

This was referenced Mar 20, 2023
@m2-community-project m2-community-project bot moved this from Pull Request In Progress to Done in Backlog Mar 30, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Backlog
  
Done
Development

Successfully merging a pull request may close this issue.

4 participants