Remove forbidden `@author` tag from `Magento_Catalog` (part 3) #36989

fredden · 2023-03-07T10:20:29Z

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.

See also magento/magento-coding-standard#382 and magento/magento-coding-standard#167

See also #36304, #36976, #36977, #36978, #36979, #36980, #36981, #36987, #36988

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-07T10:20:33Z

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-07T10:20:55Z

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.

…talog-03

magento-automated-testing · 2023-03-14T19:48:56Z

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:16: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.

leonhelmus

I have added some comments to make sure that the changes were documented, because it could influence the behavior of the method.

leonhelmus · 2023-03-20T10:07:21Z

app/code/Magento/Catalog/Block/Product/Widget/Html/Pager.php

@@ -206,6 +198,9 @@ public function getPages()
            } elseif ($this->getCurrentPage() > $this->getLastPageNum() - $half) {
                $finish = $this->getLastPageNum();
                $start = $finish - $this->_displayPages + 1;
+            } else {
+                $start = 1;


@fredden This seems to be a change that was not written in the pr. It does seem logical that it was added, but it could influence the method.

Without this change, the linter complains that $start and $finish are potentially undefined when calling range($start, $finish); on the next line of code. This seems like a necessary change to ensure the code functions as expected. While technically out of scope for "remove a comment" (this pull request), this pull request also contains a lot of other out-of-scope changes (like updating the license holder(!) and defining class constant visibility). How should we proceed?

leonhelmus · 2023-03-20T10:11:45Z

app/code/Magento/Catalog/Model/Entity/Product/Attribute/Design/Options/Container.php

@@ -29,7 +27,7 @@ public function getOptionText($value)
            }
        }
        if (isset($options[$value])) {
-            return $option[$value];


Although this seems logical i would add it in the pr, because this could be a change in behavior for this method.

This is a classic typographical error which was highlighted by the linter. Due to the way that Adobe have configured their static code analysis, problems like this go unnoticed for a long time. Would you prefer a separate pull request for this particular change?

ihor-sviziev · 2023-03-22T13:24:36Z

Adding the same priority as #36976 (comment)

…talog-03

magento-automated-testing · 2023-12-09T11:57:53Z

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please message the #magento-devops slack channel if they don't show in a reasonable amount of time and a representative will look into any issues.

engcom-Dash · 2024-11-29T13:12:00Z

@magento run all tests

engcom-Dash · 2024-12-02T08:00:09Z

@magento run all tests

engcom-Dash · 2024-12-02T09:17:54Z

Hello @fredden,

Thanks for the contributions!

Could you please take a look at this #36989 (review)?

Thanks!

engcom-Dash · 2024-12-13T09:34:49Z

Hello @fredden,

This is a reminder: Could you please take a look at this #36989 (review)?

Thanks.

fredden · 2024-12-13T18:06:19Z

@engcom-Dash I have responded to Leon's comments.

Remove forbidden @author tag

023e66c

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

fredden added 2 commits March 14, 2023 19:37

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

a274518

…talog-03

Fix static test failures

d5040e1

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

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…

ec4c523

…talog-03

engcom-Dash self-assigned this Nov 29, 2024

Merge branch '2.4-develop' into no-author/catalog-03

f7f107c

36989: fix static failures

9da27cc

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

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Remove forbidden `@author` tag from `Magento_Catalog` (part 3) #36989

Remove forbidden `@author` tag from `Magento_Catalog` (part 3) #36989

fredden commented Mar 7, 2023

m2-assistant bot commented Mar 7, 2023

magento-automated-testing bot commented Mar 7, 2023

magento-automated-testing bot commented Mar 14, 2023

magento-automated-testing bot commented Mar 14, 2023

leonhelmus left a comment

leonhelmus Mar 20, 2023

fredden Dec 13, 2024

leonhelmus Mar 20, 2023

fredden Dec 13, 2024

ihor-sviziev commented Mar 22, 2023

magento-automated-testing bot commented Dec 9, 2023

engcom-Dash commented Nov 29, 2024

engcom-Dash commented Dec 2, 2024

engcom-Dash commented Dec 2, 2024

engcom-Dash commented Dec 13, 2024

fredden commented Dec 13, 2024

Remove forbidden @author tag from Magento_Catalog (part 3) #36989

Are you sure you want to change the base?

Remove forbidden @author tag from Magento_Catalog (part 3) #36989

Conversation

fredden commented Mar 7, 2023

Description

Manual testing scenarios

Contribution checklist

m2-assistant bot commented Mar 7, 2023

magento-automated-testing bot commented Mar 7, 2023

magento-automated-testing bot commented Mar 14, 2023

magento-automated-testing bot commented Mar 14, 2023

leonhelmus left a comment

Choose a reason for hiding this comment

leonhelmus Mar 20, 2023

Choose a reason for hiding this comment

fredden Dec 13, 2024

Choose a reason for hiding this comment

leonhelmus Mar 20, 2023

Choose a reason for hiding this comment

fredden Dec 13, 2024

Choose a reason for hiding this comment

ihor-sviziev commented Mar 22, 2023

magento-automated-testing bot commented Dec 9, 2023

engcom-Dash commented Nov 29, 2024

engcom-Dash commented Dec 2, 2024

engcom-Dash commented Dec 2, 2024

engcom-Dash commented Dec 13, 2024

fredden commented Dec 13, 2024

Remove forbidden `@author` tag from `Magento_Catalog` (part 3) #36989

Remove forbidden `@author` tag from `Magento_Catalog` (part 3) #36989