PHPDoc correction spelling #31398

lfluvisotto · 2020-12-22T20:42:49Z

Description (*)

An important change for IDEs recognize methods that are @deprecated (https://docs.phpdoc.org/3.0/guide/references/phpdoc/tags/deprecated.html#deprecated) also method description/summary for {@inheritDoc} (https://docs.phpdoc.org/3.0/guide/guides/inheritance.html#inheritance)

Correct spelling for {@inheritDoc} is with D (uppercase), not d (lowercase), also correct usage for {@inheritDoc} is between parenthesis {} (https://github.com/phpDocumentor/phpDocumentor/blob/bcb5e891e14bf5b2cdd41dd6ed734adc53f0bed0/src/phpDocumentor/Descriptor/Traits/HasSummary.php#L44)

Related Pull Requests

N/A

Fixed Issues (if relevant)

N/A

Manual testing scenarios (*)

N/A

Questions or comments

N/A

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)
All automated tests passed successfully (all builds are green)

Resolved issues:

resolves [Issue] PHPDoc correction spelling #31399: PHPDoc correction spelling

m2-assistant · 2020-12-22T20:42:52Z

Hi @lfluvisotto. Thank you for your contribution
Here is some useful tips 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

You can find more information about the builds here

ℹ️ Please run only needed test builds instead of all when developing. Please run all test builds before sending your PR for review.

For more details, please, review the Magento Contributor Guide documentation.

⚠️ According to the Magento Contribution requirements, all Pull Requests must go through the Community Contributions Triage process. Community Contributions Triage is a public meeting.

🕙 You can find the schedule on the Magento Community Calendar page.

📞 The triage of Pull Requests happens in the queue order. If you want to speed up the delivery of your contribution, please join the Community Contributions Triage session to discuss the appropriate ticket.

🎥 You can find the recording of the previous Community Contributions Triage on the Magento Youtube Channel

✏️ Feel free to post questions/proposals/feedback related to the Community Contributions Triage process to the corresponding Slack Channel

lfluvisotto · 2020-12-22T20:44:36Z

@magento run all tests

lfluvisotto · 2020-12-22T20:49:14Z

Hello @ihor-sviziev + @gabrieldagama

Could any one of you be the reviewer? tiny PR and quick one.

sidolov · 2020-12-22T21:43:42Z

@magento create issue

mrtuvn · 2020-12-23T03:09:53Z

Good catch. but i also found one more mistake in file
https://github.com/magento/magento2/blob/2.4-develop/setup/src/Magento/Setup/Model/ConfigOptionsList/Directory.php#L18
Can you correct that line too ? @lfluvisotto

ihor-sviziev

Could you fix also this one? #31398 (comment)

lfluvisotto · 2020-12-23T15:26:37Z

@mrtuvn + @ihor-sviziev requested changes done.

ihor-sviziev · 2020-12-23T15:35:41Z

@magento run all tests

ihor-sviziev · 2020-12-23T18:23:11Z

@magento run Static Tests, Functional Tests EE

ihor-sviziev · 2020-12-23T18:23:40Z

@magento run Functional Tests B2B

lfluvisotto · 2024-08-20T12:16:42Z

@engcom-Delta PR conflicts solved.

ihor-sviziev · 2024-08-21T15:07:33Z

@lfluvisotto, could you also fix static test failures?

engcom-Dash · 2024-11-04T13:51:51Z

Hello @lfluvisotto,

Thanks for the contributions!

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

Thanks.

ihor-sviziev · 2024-11-13T10:15:16Z

@engcom-Dash, I fixed the conflict. Could you pls help fixing static test failures?

engcom-Dash · 2024-11-14T10:15:57Z

@magento run all tests

engcom-Dash · 2024-11-14T14:54:40Z

@magento run all tests

engcom-Dash · 2024-11-14T14:58:27Z

@engcom-Dash, I fixed the conflict. Could you pls help fixing static test failures?

Thank you, @ihor-sviziev. I have fixed the static failures in all the files. While I have addressed only the static failures, there are a large number of files, so if possible, could you kindly review them? Thank you!

engcom-Dash · 2024-11-15T09:20:34Z

@magento run all tests

engcom-Dash · 2024-11-15T11:18:50Z

Manual testing is not required, as the changes involve spelling corrections and a few static failure fixes. Builds are failed, hence moving it to Extended Testing.

engcom-Dash · 2024-11-15T14:04:46Z

@magento run all tests

engcom-Dash · 2024-11-18T06:57:59Z

The Functional B2B Functional CE and test failures are different in recent 2 successive builds. They neither part of PR nor failing because of the PR changes, hence moving it to Merge in Progress.

Functional B2B

Run 1: https://public-results-storage-prod.magento-testing-service.engineering/reports/magento/magento2/pull/31398/bee82c98eac7e385367f7950ce55c704/Functional/allure-report-b2b/index.html#categories/6e0f61c8b67b0f191eaf93c92554bd16/afecc4ad152ae2f3/

Run 2: https://public-results-storage-prod.magento-testing-service.engineering/reports/magento/magento2/pull/31398/6e49c8e63d30d46bcc3a6d0d077d66b4/Functional/allure-report-b2b/index.html#categories/6ca9d315ebd9ab54dbe1fb9148ebdc1f/85d9e6617a7544b2/

Functional CE

Run 1: https://public-results-storage-prod.magento-testing-service.engineering/reports/magento/magento2/pull/31398/6b3461e62fbdf40a5f61a2ac29e66de3/Functional/allure-report-ee/index.html#categories/a644910ae0cb11e839a98baa21929b76/b88e11e5a797ca25/

Run 2: https://public-results-storage-prod.magento-testing-service.engineering/reports/magento/magento2/pull/31398/e528aea29aff8dc6facb1392c6af3ea1/Functional/allure-report-ee/index.html#categories/564e7e97f9657fc0b9892ce7b985ae13/f8ca4e494a7de660/

engcom-Dash · 2024-11-22T07:38:09Z

The Functional B2B Functional CE and test failures are different in recent 2 successive builds. They neither part of PR nor failing because of the PR changes, hence moving it to Merge in Progress.

Functional B2B

Run 1: https://public-results-storage-prod.magento-testing-service.engineering/reports/magento/magento2/pull/31398/bee82c98eac7e385367f7950ce55c704/Functional/allure-report-b2b/index.html#categories/6e0f61c8b67b0f191eaf93c92554bd16/afecc4ad152ae2f3/

Run 2: https://public-results-storage-prod.magento-testing-service.engineering/reports/magento/magento2/pull/31398/6e49c8e63d30d46bcc3a6d0d077d66b4/Functional/allure-report-b2b/index.html#categories/6ca9d315ebd9ab54dbe1fb9148ebdc1f/85d9e6617a7544b2/
**Functional CE**
Run 1: https://public-results-storage-prod.magento-testing-service.engineering/reports/magento/magento2/pull/31398/6b3461e62fbdf40a5f61a2ac29e66de3/Functional/allure-report-ee/index.html#categories/a644910ae0cb11e839a98baa21929b76/b88e11e5a797ca25/

Run 2: https://public-results-storage-prod.magento-testing-service.engineering/reports/magento/magento2/pull/31398/e528aea29aff8dc6facb1392c6af3ea1/Functional/allure-report-ee/index.html#categories/564e7e97f9657fc0b9892ce7b985ae13/f8ca4e494a7de660/

Moving back to ET due to a consistent failure in the functional test B2B.

engcom-Dash · 2024-11-22T07:39:03Z

@magento run all tests

engcom-Dash · 2024-11-22T13:55:20Z

The Functional B2B and CE test failures are different in recent 2 successive builds. They neither part of PR nor failing because of the PR changes, hence moving it to Merge in Progress.

Functional Tests B2B
Run 1: https://public-results-storage-prod.magento-testing-service.engineering/reports/magento/magento2/pull/31398/6e49c8e63d30d46bcc3a6d0d077d66b4/Functional/allure-report-b2b/index.html#categories/6ca9d315ebd9ab54dbe1fb9148ebdc1f/85d9e6617a7544b2/

Run 2: https://public-results-storage-prod.magento-testing-service.engineering/reports/magento/magento2/pull/31398/227309114caf1d768dbaf35c3a0266be/Functional/allure-report-b2b/index.html#categories/cf19a5cdd5d94474ce2e42f5fbf0d5e4/24cc633cb436bb5c/

Functional Tests CE
Run 1: https://public-results-storage-prod.magento-testing-service.engineering/reports/magento/magento2/pull/31398/e528aea29aff8dc6facb1392c6af3ea1/Functional/allure-report-ee/index.html#categories/564e7e97f9657fc0b9892ce7b985ae13/f8ca4e494a7de660/

Run 2: https://public-results-storage-prod.magento-testing-service.engineering/reports/magento/magento2/pull/31398/e1da0895b755a34f164b3487d6d3c96f/Functional/allure-report-ce/index.html#categories/6d7e37752c3cc83cb3d2063131f608bb/5008c0b40019d7ec/

magento-engcom-team added Component: Swatches Release Line: 2.4 labels Dec 22, 2020

m2-assistant bot mentioned this pull request Dec 22, 2020

[Issue] PHPDoc correction spelling #31399

Closed

4 tasks

sidolov added the Auto-Tests: Not Required Changes in Pull Request does not require coverage by auto-tests label Dec 22, 2020

m2-community-project bot added the Progress: pending review label Dec 22, 2020

ihor-sviziev self-assigned this Dec 23, 2020

m2-community-project bot added Progress: review and removed Progress: pending review labels Dec 23, 2020

ihor-sviziev requested changes Dec 23, 2020

View reviewed changes

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

ihor-sviziev added the Cleanup label Dec 23, 2020

lfluvisotto force-pushed the 2.4-develop-phpdoc-correction-spelling branch from b42fede to d83c03b Compare December 23, 2020 15:24

ihor-sviziev added the Progress: review label Dec 23, 2020

m2-community-project bot removed the Progress: needs update label Dec 23, 2020

Merge branch '2.4-develop' into 2.4-develop-phpdoc-correction-spelling

8a6e199

ihor-sviziev approved these changes Nov 13, 2024

View reviewed changes

m2-community-project bot added Progress: ready for testing and removed Progress: needs update labels Nov 13, 2024

engcom-Dash self-assigned this Nov 14, 2024

31398: fix static failures

dc75032

ihor-sviziev approved these changes Nov 14, 2024

View reviewed changes

engcom-Bravo added the Triage: Dev.Experience Issue related to Developer Experience and needs help with Triage to Confirm or Reject it label Nov 15, 2024

31398: fix static failures

90090e5

Merge branch '2.4-develop' into 2.4-develop-phpdoc-correction-spelling

a8072a4

engcom-Dash added Progress: extended testing and removed Progress: ready for testing labels Nov 22, 2024

Merge branch '2.4-develop' into 2.4-develop-phpdoc-correction-spelling

4885e82

engcom-Dash added Progress: accept and removed Progress: extended testing labels Nov 22, 2024

magento-devops-reposync-svc merged commit 0b9e5a6 into magento:2.4-develop Dec 24, 2024
10 of 12 checks passed

PHPDoc correction spelling #31398

PHPDoc correction spelling #31398

Uh oh!

Conversation

lfluvisotto commented Dec 22, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description (*)

Related Pull Requests

Fixed Issues (if relevant)

Manual testing scenarios (*)

Questions or comments

Contribution checklist (*)

Resolved issues:

Uh oh!

m2-assistant bot commented Dec 22, 2020

Uh oh!

lfluvisotto commented Dec 22, 2020

Uh oh!

lfluvisotto commented Dec 22, 2020

Uh oh!

sidolov commented Dec 22, 2020

Uh oh!

mrtuvn commented Dec 23, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ihor-sviziev left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lfluvisotto commented Dec 23, 2020

Uh oh!

ihor-sviziev commented Dec 23, 2020

Uh oh!

ihor-sviziev commented Dec 23, 2020

Uh oh!

ihor-sviziev commented Dec 23, 2020

Uh oh!

lfluvisotto commented Aug 20, 2024

Uh oh!

ihor-sviziev commented Aug 21, 2024

Uh oh!

engcom-Dash commented Nov 4, 2024

Uh oh!

ihor-sviziev commented Nov 13, 2024

Uh oh!

engcom-Dash commented Nov 14, 2024

Uh oh!

engcom-Dash commented Nov 14, 2024

Uh oh!

engcom-Dash commented Nov 14, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

engcom-Dash commented Nov 15, 2024

Uh oh!

engcom-Dash commented Nov 15, 2024

Uh oh!

engcom-Dash commented Nov 15, 2024

Uh oh!

engcom-Dash commented Nov 18, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

engcom-Dash commented Nov 22, 2024

Uh oh!

engcom-Dash commented Nov 22, 2024

Uh oh!

engcom-Dash commented Nov 22, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

9 participants

lfluvisotto commented Dec 22, 2020 •

edited

Loading

mrtuvn commented Dec 23, 2020 •

edited

Loading

ihor-sviziev left a comment •

edited

Loading

engcom-Dash commented Nov 14, 2024 •

edited

Loading

engcom-Dash commented Nov 18, 2024 •

edited

Loading

engcom-Dash commented Nov 22, 2024 •

edited

Loading