Description
This issue is automatically created based on existing pull request: #37018: Remove forbidden @author
tag from framework (part 1)
Description
According to https://devdocs.magento.com/guides/v2.4/coding-standards/docblock-standard-general.html#documentation-space, the @author
tag is not permitted in Magento. This pull request removes this tag from some modules. Given there are so many instances of this tag, I've opened a small pull request to get the process started. I expect that the linter will force me to fix several other coding standards violations on the way, so having a smaller pull request means that task is easier to manage. I plan to open more pull requests to tackle the other instances of this tag.
See also magento/magento-coding-standard#382 and magento/magento-coding-standard#167
Manual testing scenarios
There are not code changes in this pull request. This pull request only removes forbidden comments.
Contribution checklist
- Pull request has a meaningful description of its purposeAll commits are accompanied by meaningful commit messagesAll new or changed code is covered with unit/integration tests (if applicable)README.md files for modified modules are updated and included in the pull request if any README.md predefined sections require an updateAll automated tests passed successfully (all builds are green)
Activity
@author
tag from framework (part 1) #37018m2-assistant commentedon Mar 27, 2023
Hi @engcom-November. Thank you for working on this issue.
In order to make sure that issue has enough information and ready for development, please read and check the following instruction: 👇
Area: XXXXX
label to the ticket, indicating the functional areas it may be related to.2.4-develop
branchDetails
- Add the comment@magento give me 2.4-develop instance
to deploy test instance on Magento infrastructure.- If the issue is reproducible on
2.4-develop
branch, please, add the labelReproduced on 2.4.x
.- If the issue is not reproducible, add your comment that issue is not reproducible and close the issue and stop verification process here!
Issue: Confirmed
once verification is complete.engcom-November commentedon Mar 27, 2023
Hello @fredden
Thanks for the report and collaboration!
We can see the PR related to this GitHub issue contains the improvement in the DocBlock as mentioned in the documentation
https://github.com/author
,@category
,@Package
, and@subpackage
MUST NOT be used. Documentation is organized with the use of namespaces.Hence confirming this issue for further processing.
Thanks
github-jira-sync-bot commentedon Mar 27, 2023
✅ Jira issue https://jira.corp.adobe.com/browse/AC-8348 is successfully created for this GitHub issue.
m2-assistant commentedon Mar 27, 2023
✅ Confirmed by @engcom-November. Thank you for verifying the issue.
Issue Available: @engcom-November, You will be automatically unassigned. Contributors/Maintainers can claim this issue to continue. To reclaim and continue work, reassign the ticket to yourself.