Skip to content

Fix PHPDoc spelling in migrations, repositories, and health checks#23068

Merged
enricobattocchi merged 1 commit intoYoast:trunkfrom
meravi:fix/phpdoc-spelling-cleanup
Apr 20, 2026
Merged

Fix PHPDoc spelling in migrations, repositories, and health checks#23068
enricobattocchi merged 1 commit intoYoast:trunkfrom
meravi:fix/phpdoc-spelling-cleanup

Conversation

@meravi
Copy link
Copy Markdown
Contributor

@meravi meravi commented Mar 10, 2026

Context

Spelling mistakes in PHPDoc comments across migration, repository, and health-check classes make the documentation less professional and can cause confusion. This PR corrects them.

Summary

This PR can be summarized in the following changelog entry:

  • Fixes some PHPDoc spelling mistakes. Props to @meravi.

Relevant technical choices:

  • Docs-only change — no runtime behaviour is affected.

Test instructions

Test instructions for the acceptance test before the PR gets merged

This PR can be acceptance tested by following these steps:

  • This PR only changes PHPDoc comments; no functional behaviour was altered. Verify the corrected spellings in the changed files:
    • lib/migrations/table.php@throws docblock on finish()
    • src/repositories/seo-links-repository.php@return docblocks on delete_all_by_post_id(), delete_all_by_post_id_where_indexable_id_null(), delete_all_by_indexable_id(), delete_many_by_id(), and insert_many()
    • src/services/health-check/default-tagline-runner.php@return docblock on is_successful()
    • src/services/health-check/links-table-runner.php@return docblock on is_successful()

Relevant test scenarios

  • Changes should be tested with the browser console open
  • Changes should be tested on different posts/pages/taxonomies/custom post types/custom taxonomies
  • Changes should be tested on different editors (Default Block/Gutenberg/Classic/Elementor/other)
  • Changes should be tested on different browsers
  • Changes should be tested on multisite

Test instructions for QA when the code is in the RC

  • QA should use the same steps as above.

QA can test this PR by following these steps:

  • NA

Impact check

This PR affects the following parts of the plugin, which may require extra testing:

  • No runtime code was changed; only PHPDoc comments were corrected.

Other environments

  • This PR also affects Shopify. I have added a changelog entry starting with [shopify-seo], added test instructions for Shopify and attached the Shopify label to this PR.
  • This PR also affects Yoast SEO for Google Docs. I have added a changelog entry starting with [yoast-doc-extension], added test instructions for Yoast SEO for Google Docs and attached the Google Docs Add-on label to this PR.

Documentation

  • I have written documentation for this change. For example, comments in the Relevant technical choices, comments in the code, documentation on Confluence / shared Google Drive / Yoast developer portal, or other.

Quality assurance

  • I have tested this code to the best of my abilities.
  • During testing, I had activated all plugins that Yoast SEO provides integrations for.
  • I have added unit tests to verify the code works as intended.
  • If any part of the code is behind a feature flag, my test instructions also cover cases where the feature flag is switched off.
  • I have written this PR in accordance with my team's definition of done.
  • I have checked that the base branch is correctly set.
  • I have run grunt build:images and commited the results, if my PR introduces new images or SVGs.

Innovation

  • No innovation project is applicable for this PR.
  • This PR falls under an innovation project. I have attached the innovation label.
  • I have added my hours to the WBSO document.

Fixes #

@meravi
Copy link
Copy Markdown
Contributor Author

meravi commented Apr 3, 2026

Please review @vraja-pro :)

@enricobattocchi enricobattocchi added this to the 27.6 milestone Apr 20, 2026
@enricobattocchi enricobattocchi merged commit ddbab1d into Yoast:trunk Apr 20, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants