Skip to content

PHPDoc correction spelling#40745

Open
lfluvisotto wants to merge 1 commit intomagento:2.4-developfrom
lfluvisotto:phpdoc-correction-spelling
Open

PHPDoc correction spelling#40745
lfluvisotto wants to merge 1 commit intomagento:2.4-developfrom
lfluvisotto:phpdoc-correction-spelling

Conversation

@lfluvisotto
Copy link
Copy Markdown
Contributor

@lfluvisotto lfluvisotto commented Apr 16, 2026

Description (*)

This pull request fixes PHPDoc inconsistencies by correcting spelling and standardizing the use of annotations.

Specifically:

Corrected misspellings in PHPDoc blocks.
Replaced incorrect or inconsistent references.
Ensured compliance with phpDocumentor guidelines.

These changes improve documentation clarity as described in phpDocumentor documentation.

Related Pull Requests

#31398

Fixed Issues (if relevant)

N/A

Manual testing scenarios (*)

Run documentation generation tools (e.g., phpDocumentor) and verify no warnings related to PHPDoc.

Questions or comments

This change is documentation-only and does not modify runtime behavior.

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)

Resolved issues:

  1. resolves [Issue] PHPDoc correction spelling #40763: PHPDoc correction spelling

@m2-assistant
Copy link
Copy Markdown

m2-assistant Bot commented Apr 16, 2026

Hi @lfluvisotto. Thank you for your contribution!
Here are some useful tips on how you can test your changes using Magento test environment.
❗ 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:
  1. Database Compare
  2. Functional Tests CE
  3. Functional Tests EE
  4. Functional Tests B2B
  5. Integration Tests
  6. Magento Health Index
  7. Sample Data Tests CE
  8. Sample Data Tests EE
  9. Sample Data Tests B2B
  10. Static Tests
  11. Unit Tests
  12. WebAPI Tests
  13. 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.

@ct-prd-pr-scan
Copy link
Copy Markdown

The security team has been informed about this pull request due to the presence of risky security keywords. For security vulnerability reports, please visit Adobe's vulnerability disclosure program on HackerOne or email psirt@adobe.com.

2 similar comments
@ct-prd-pr-scan
Copy link
Copy Markdown

The security team has been informed about this pull request due to the presence of risky security keywords. For security vulnerability reports, please visit Adobe's vulnerability disclosure program on HackerOne or email psirt@adobe.com.

@ct-prd-pr-scan
Copy link
Copy Markdown

The security team has been informed about this pull request due to the presence of risky security keywords. For security vulnerability reports, please visit Adobe's vulnerability disclosure program on HackerOne or email psirt@adobe.com.

@lfluvisotto lfluvisotto force-pushed the phpdoc-correction-spelling branch from 62b6298 to 5d655ef Compare April 16, 2026 23:54
@ct-prd-pr-scan
Copy link
Copy Markdown

The security team has been informed about this pull request due to the presence of risky security keywords. For security vulnerability reports, please visit Adobe's vulnerability disclosure program on HackerOne or email psirt@adobe.com.

@lfluvisotto
Copy link
Copy Markdown
Contributor Author

@magento run all tests

@engcom-Dash
Copy link
Copy Markdown
Contributor

@magento create issue

@ct-prd-pr-scan
Copy link
Copy Markdown

The security team has been informed about this pull request due to the presence of risky security keywords. For security vulnerability reports, please visit Adobe's vulnerability disclosure program on HackerOne or email psirt@adobe.com.

@engcom-Dash engcom-Dash added the Priority: P4 No current plan to fix. Fixing can be deferred as a logical part of more important work. label Apr 21, 2026
@github-project-automation github-project-automation Bot moved this to Pending Review in Pull Requests Dashboard Apr 21, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Priority: P4 No current plan to fix. Fixing can be deferred as a logical part of more important work. Progress: pending review

Projects

Status: Pending Review

Development

Successfully merging this pull request may close these issues.

[Issue] PHPDoc correction spelling

2 participants