Skip to content

[Issue] Remove forbidden @author tag from framework (part 1) #37268

Open
@m2-assistant

Description

@m2-assistant

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 purpose
    All commits are accompanied by meaningful commit messages
    All 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 update
    All automated tests passed successfully (all builds are green)

Activity

added
Priority: P2A defect with this priority could have functionality issues which are not to expectations.
on Mar 22, 2023
m2-assistant

m2-assistant commented on Mar 27, 2023

@m2-assistant
Author

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: 👇

  • 1. Verify that issue has all the required information. (Preconditions, Steps to reproduce, Expected result, Actual result).
    2. Verify that issue has a meaningful description and provides enough information to reproduce the issue.
    3. Add Area: XXXXX label to the ticket, indicating the functional areas it may be related to.
    4. 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!
    5. Add label Issue: Confirmed once verification is complete.
    6. Make sure that automatic system confirms that report has been added to the backlog.
engcom-November

engcom-November commented on Mar 27, 2023

@engcom-November
Contributor

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

added
Issue: ConfirmedGate 3 Passed. Manual verification of the issue completed. Issue is confirmed
Reproduced on 2.4.xThe issue has been reproduced on latest 2.4-develop branch
Reported on 2.4.xIndicates original Magento version for the Issue report.
on Mar 27, 2023
github-jira-sync-bot

github-jira-sync-bot commented on Mar 27, 2023

@github-jira-sync-bot

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

m2-assistant

m2-assistant commented on Mar 27, 2023

@m2-assistant
Author

✅ 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.

moved this to Pull Request In Progress in High Priority Backlogon Aug 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

Area: FrameworkIssue: ConfirmedGate 3 Passed. Manual verification of the issue completed. Issue is confirmedIssue: ready for confirmationPriority: P2A defect with this priority could have functionality issues which are not to expectations.Progress: PR in progressReported on 2.4.xIndicates original Magento version for the Issue report.Reproduced on 2.4.xThe issue has been reproduced on latest 2.4-develop branch

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

    Development

    Participants

    @fredden@engcom-November@github-jira-sync-bot

    Issue actions

      [Issue] Remove forbidden `@author` tag from framework (part 1) · Issue #37268 · magento/magento2