Skip to content

Preserve proper names in website spellcheck - #377

Merged
glenn-jocher merged 1 commit into
mainfrom
fix/spellcheck-proper-names-20261101
Nov 1, 2026
Merged

glenn-jocher merged 1 commit into
mainfrom
fix/spellcheck-proper-names-20261101

Conversation

@glenn-jocher

@glenn-jocher glenn-jocher commented Nov 1, 2026 •

Copy link
Copy Markdown
Member

Website spellcheck reports Labour ==> Labor in International Labour Organization and Storey ==> Story in Margaret-Anne Storey. Both are correct proper names in the CMS and on the published pages.

Exempt only these exact, case-sensitive, word-bounded phrases while retaining en-GB_to_en-US and the existing .alls exception. Use the existing codespell multiline exclusion option so matching happens before URI stripping, which otherwise consumes International immediately after an HTML link URL. Ordinary British spellings, including Labour and Storey elsewhere on the same line, remain errors. No CMS content changes.

Validation:

  • Reproduced both failures on the two live pages with the previous command; the updated command reports zero errors.
  • Verified six same-line controls still fail: labour, storey, colour, organise, Labour, and Storey.
  • Verified longer phrases do not inherit the exceptions and .alls remains excluded.
  • YAML parsing, Prettier, and git diff --check pass.

🛠️ PR Summary

Made with ❤️ by Ultralytics Actions

🌟 Summary

The website spellcheck now exempts two exact proper-name phrases without suppressing British spelling errors elsewhere.

📊 Key Changes

  • Updated the codespell workflow to use its multiline exclusion option for .alls and the phrases International Labour Organization and Margaret-Anne Storey.
  • Kept the existing en-GB_to_en-US spelling checks, so standalone Labour and Storey remain flagged.
  • No CMS content was changed.

🎯 Purpose & Impact

  • The two proper names no longer trigger spellcheck errors, while the existing spelling checks and .alls exception remain in place.

@UltralyticsAssistant UltralyticsAssistant added devops GitHub Devops or MLops fixed Bug has been resolved labels Nov 1, 2026
@UltralyticsAssistant

Copy link
Copy Markdown
Member

👋 Hello @glenn-jocher, thank you for submitting a ultralytics/docs 🚀 PR! This automated message confirms your contribution was received, and an Ultralytics engineer will assist with the review. To ensure a seamless integration of your work, please review the following checklist:

  • ✅ Define a Purpose: Clearly explain the purpose of your fix or feature in your PR description, and link to any relevant issues. Ensure your commit messages are clear, concise, and adhere to the project's conventions.
  • ✅ Synchronize with Source: Confirm your PR is synchronized with the ultralytics/docs main branch. If it's behind, update it by clicking the 'Update branch' button or by running git pull and git merge main locally.
  • ✅ Ensure CI Checks Pass: Verify all Ultralytics Continuous Integration (CI) checks are passing. If any checks fail, please address the issues.
  • ✅ Update Documentation: Update the relevant documentation for any new or modified features.
  • ✅ Add Tests: If applicable, include or update tests to cover your changes, and confirm that all tests are passing.
  • ✅ Sign the CLA: Please ensure you have signed our Contributor License Agreement if this is your first Ultralytics PR; the CLA check will comment with signing instructions if needed.
  • ✅ Minimize Changes: Limit your changes to the minimum necessary for your bug fix or feature addition. "It is not daily increase but daily decrease, hack away the unessential. The closer to the source, the less wastage there is." — Bruce Lee

For more guidance, please refer to our Contributing Guide. Don't hesitate to leave a comment if you have any questions. Thank you for contributing to Ultralytics! 🚀

@UltralyticsAssistant UltralyticsAssistant left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🔍 PR Review

Made with ❤️ by Ultralytics Actions

Reviewed the spelling-check workflow change. The exclusions are limited to the two exact, case-sensitive, word-bounded phrases, while retaining the .alls exception and the existing British-spelling checks. LGTM.

@glenn-jocher
glenn-jocher merged commit 936421e into main Nov 1, 2026
6 checks passed
@glenn-jocher
glenn-jocher deleted the fix/spellcheck-proper-names-20261101 branch November 1, 2026 14:00
@UltralyticsAssistant

Copy link
Copy Markdown
Member

🎉 This PR has been merged—thank you, @glenn-jocher!

“Well done is better than well said.” — Benjamin Franklin

The targeted exceptions preserve the existing British-English checks while allowing these two proper names.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

devops GitHub Devops or MLops fixed Bug has been resolved

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants