[Issue] Remove forbidden `@author` tag from `Magento_Catalog` (part 2)

m2-assistant[bot] commented 1 year ago

This issue is automatically created based on existing pull request: magento/magento2#36988: Remove forbidden @author tag from Magento_Catalog (part 2)

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 of) the Magento_Catalog module. 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.

Manual testing scenarios

There are not code changes in this pull request. This pull request only removes forbidden comments.

Contribution checklist

[x] Pull request has a meaningful description of its purpose
[x] All commits are accompanied by meaningful commit messages
[x] All new or changed code is covered with unit/integration tests (if applicable)
[x] README.md files for modified modules are updated and included in the pull request if any README.md predefined sections require an update
[x] All automated tests passed successfully (all builds are green)

m2-assistant[bot] commented 1 year ago

Hi @engcom-Dash. 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: :point_down:

1. Verify that issue has all the required information. (Preconditions, Steps to reproduce, Expected result, Actual result).
1. Verify that issue has a meaningful description and provides enough information to reproduce the issue.
1. Add Area: XXXXX label to the ticket, indicating the functional areas it may be related to.
1. Verify that the issue is reproducible on 2.4-develop branch
  Details
  - 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 label Reproduced 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!

Join Magento Community Engineering Slack and ask your questions in #github channel.

engcom-Dash commented 1 year ago

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 below documentation:

https://developer.adobe.com/commerce/php/coding-standards/docblock/#structure-of-documentation-space

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 commented 1 year ago

:white_check_mark: Jira issue https://jira.corp.adobe.com/browse/AC-8370 is successfully created for this GitHub issue.

m2-assistant[bot] commented 1 year ago

:white_check_mark: Confirmed by @engcom-Dash. Thank you for verifying the issue.
Issue Available: @engcom-Dash, You will be automatically unassigned. Contributors/Maintainers can claim this issue to continue. To reclaim and continue work, reassign the ticket to yourself.

magento / magento2