Remove forbidden `@author` tag from `Magento_Captcha` and `Magento_Cms` #36980

fredden · 2023-03-06T22:35:45Z

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 the Magento_Captcha and Magento_Cms 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

See also #36304, #36976, #36977, #36978, #36979

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)

m2-assistant · 2023-03-06T22:35:48Z

Hi @fredden. Thank you for your contribution!
Here are some useful tips on how you can test your changes using Magento test environment.

Add the comment under your pull request to deploy test or vanilla Magento instance:

@magento give me test instance - deploy test instance based on PR changes
@magento give me 2.4-develop instance - deploy vanilla Magento instance

❗ Automated tests can be triggered manually with an appropriate comment:

@magento run all tests - run or re-run all required tests against the PR changes
@magento run <test-build(s)> - run or re-run specific test build(s)
For example: @magento run Unit Tests

<test-build(s)> is a comma-separated list of build names.

Allowed build names are:

Database Compare
Functional Tests CE
Functional Tests EE
Functional Tests B2B
Integration Tests
Magento Health Index
Sample Data Tests CE
Sample Data Tests EE
Sample Data Tests B2B
Static Tests
Unit Tests
WebAPI Tests
Semantic Version Checker

You can find more information about the builds here
ℹ️ Run only required test builds during development. Run all test builds before sending your pull request for review.

For more details, review the Code Contributions documentation.
Join Magento Community Engineering Slack and ask your questions in #github channel.

magento-automated-testing · 2023-03-06T22:36:04Z

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

…ptcha-cms

magento-automated-testing · 2023-03-14T17:45:08Z

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

magento-automated-testing · 2023-03-14T22:13:14Z

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

leonhelmus · 2023-03-20T09:21:08Z

app/code/Magento/Cms/Block/Widget/Block.php

-                return $block;
-            } catch (NoSuchEntityException $e) {
-            }
+            $storeId = $this->_storeManager->getStore()->getId();


@fredden I think this change could have influence on current implementation. Or you are sure that NoSuchEntityException never is thrown? If you are i'll approve it.

I have restored the existing code here to ensure that this pull request does not inadvertently change behaviour. I initially removed it because the linter detected the empty catch block and complained. I didn't see a good reason at the time to keep the block. I agree that removing it is a behaviour change which is out of scope for this particular pull request. I'll let others fix the code when they are ready to do so. Thanks for highlighting this out-of-scope change.

ihor-sviziev · 2023-03-22T13:23:35Z

Adding the same priority as #36976 (comment)

engcom-Dash · 2024-10-23T08:04:16Z

Hello @fredden ,

Thanks for the contributions!

Please resolve the conflict so we can proceed with this PR.

Thanks.

fredden · 2024-10-23T09:11:38Z

I should be able to sort this out in the next few days.

…ptcha-cms

fredden · 2024-10-24T16:28:29Z

@magento run all tests

engcom-Dash · 2024-11-29T12:07:35Z

Hello @fredden,

Thanks for resolving the conflicts.

I have fixed the static failure, but there is one review comment that needs to be resolved before proceeding further. Could you please address #36980 (comment)?

Thanks again!

engcom-Dash · 2024-11-29T12:07:55Z

@magento run all tests

engcom-Dash · 2024-12-13T09:36:37Z

Hello @fredden,

Thanks for resolving the conflicts.

I have fixed the static failure, but there is one review comment that needs to be resolved before proceeding further. Could you please address #36980 (comment)?

Thanks again!

Hello @fredden,

This is a reminder: Could you please address #36980 (comment)?

Thanks.

fredden · 2024-12-13T17:53:41Z

@magento run all tests

fredden · 2024-12-13T17:54:09Z

@engcom-Dash I have adjusted the code and requested another review from Leon.

Remove forbidden @author tag

12d2bf5

m2-github-services added Partner: Fisheye partners-contribution Pull Request is created by Magento Partner labels Mar 6, 2023

fredden added 2 commits March 14, 2023 17:35

Merge remote-tracking branch 'upstream/2.4-develop' into no-author/ca…

ce202ef

…ptcha-cms

Fix static test failures

9f829bf

Fix static test failure

521ce61

leonhelmus suggested changes Mar 20, 2023

View reviewed changes

m2-community-project bot assigned leonhelmus Mar 20, 2023

m2-community-project bot added the Progress: needs update label Mar 20, 2023

This was referenced Mar 20, 2023

[Issue] Remove forbidden @author tag from Magento_Customer (part 2) #37250

Closed

[Issue] Remove forbidden @author tag from Magento_Downloadable #37251

Open

[Issue] Remove forbidden @author tag from Magento_Eav #37252

Open

ihor-sviziev added the Priority: P2 A defect with this priority could have functionality issues which are not to expectations. label Mar 22, 2023

Merge remote-tracking branch 'upstream/2.4-develop' into no-author/ca…

bd0fb1b

…ptcha-cms

engcom-Dash self-assigned this Nov 29, 2024

engcom-Dash and others added 4 commits November 29, 2024 16:40

Merge branch '2.4-develop' into no-author/captcha-cms

4faab30

36980: fix static failure

20b7a31

36980: fix static failure in remaining file

7ddc807

36980: add a new line after copyright tag

fa9c4ac

Restore try/catch blocks with empty catch

8d3b154

m2-community-project bot added Progress: review and removed Progress: needs update labels Dec 13, 2024

fredden requested a review from leonhelmus December 13, 2024 17:53

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Remove forbidden `@author` tag from `Magento_Captcha` and `Magento_Cms` #36980

Remove forbidden `@author` tag from `Magento_Captcha` and `Magento_Cms` #36980

fredden commented Mar 6, 2023

m2-assistant bot commented Mar 6, 2023

magento-automated-testing bot commented Mar 6, 2023

magento-automated-testing bot commented Mar 14, 2023

magento-automated-testing bot commented Mar 14, 2023

leonhelmus Mar 20, 2023 •

edited

Loading

fredden Dec 13, 2024

ihor-sviziev commented Mar 22, 2023

engcom-Dash commented Oct 23, 2024

fredden commented Oct 23, 2024

fredden commented Oct 24, 2024

engcom-Dash commented Nov 29, 2024 •

edited

Loading

engcom-Dash commented Nov 29, 2024

engcom-Dash commented Dec 13, 2024

fredden commented Dec 13, 2024

fredden commented Dec 13, 2024

Remove forbidden @author tag from Magento_Captcha and Magento_Cms #36980

Are you sure you want to change the base?

Remove forbidden @author tag from Magento_Captcha and Magento_Cms #36980

Conversation

fredden commented Mar 6, 2023

Description

Manual testing scenarios

Contribution checklist

m2-assistant bot commented Mar 6, 2023

magento-automated-testing bot commented Mar 6, 2023

magento-automated-testing bot commented Mar 14, 2023

magento-automated-testing bot commented Mar 14, 2023

leonhelmus Mar 20, 2023 • edited Loading

Choose a reason for hiding this comment

fredden Dec 13, 2024

Choose a reason for hiding this comment

ihor-sviziev commented Mar 22, 2023

engcom-Dash commented Oct 23, 2024

fredden commented Oct 23, 2024

fredden commented Oct 24, 2024

engcom-Dash commented Nov 29, 2024 • edited Loading

engcom-Dash commented Nov 29, 2024

engcom-Dash commented Dec 13, 2024

fredden commented Dec 13, 2024

fredden commented Dec 13, 2024

Remove forbidden `@author` tag from `Magento_Captcha` and `Magento_Cms` #36980

Remove forbidden `@author` tag from `Magento_Captcha` and `Magento_Cms` #36980

leonhelmus Mar 20, 2023 •

edited

Loading

engcom-Dash commented Nov 29, 2024 •

edited

Loading