Skip to content

Remove codespell rare dictionary from website spellcheck#341

Open
JaviChulvi wants to merge 1 commit into
ultralytics:mainfrom
JaviChulvi:fix/codespell-rare-false-positives
Open

Remove codespell rare dictionary from website spellcheck#341
JaviChulvi wants to merge 1 commit into
ultralytics:mainfrom
JaviChulvi:fix/codespell-rare-false-positives

Conversation

@JaviChulvi

@JaviChulvi JaviChulvi commented Jul 18, 2026

Copy link
Copy Markdown

Summary

The daily Website links and spellcheck workflow reports valid LVIS class names as spelling errors:

  • mangermanager
  • troughthrough

Both are valid nouns in the LVIS class label manger/trough (an animal-feeding container) and should not be "corrected".

Root cause

The Check spelling step in .github/workflows/links.yml runs codespell with --builtin clear,rare,informal,en-GB_to_en-US. Codespell's rare dictionary explicitly maps both words as likely typos:

dictionary_rare.txt :: manger->manager
dictionary_rare.txt :: trough->through

Verified these two entries exist only in dictionary_rare.txt, not in clear, informal, or en-GB_to_en-US, so removing rare fixes them at the source with no reappearance from another dictionary.

Change

-            --builtin clear,rare,informal,en-GB_to_en-US \
+            --builtin clear,informal,en-GB_to_en-US \

This fixes the source rather than adding individual --ignore-words-list exceptions, keeping the high-confidence clear, informal, and en-GB_to_en-US checks that are appropriate for a Slack-paging daily check.

Trade-off

Dropping rare also drops its coverage of other genuine-but-uncommon typos. That is the deliberate trade: rare is opt-in precisely because it assumes uncommon-but-valid words are probably typos — the wrong premise for scanning a real technical website full of model names, dataset labels, and ML jargon. For a daily check that pages a human via Slack, noise reduction is the right call.

Notes

Closes #340

Ref: Slack thread https://ultralytics-work.slack.com/archives/C01EDRWJ95W/p1784360628239059

🛠️ PR Summary

Made with ❤️ by Ultralytics Actions

🌟 Summary

Removes the Codespell rare dictionary from the website spellcheck workflow. 🔤

📊 Key Changes

  • Updates .github/workflows/links.yml to stop using the rare Codespell dictionary.
  • Retains the clear, informal, and en-GB_to_en-US dictionaries and existing ignore rules.

🎯 Purpose & Impact

  • Reduces false-positive spelling warnings caused by uncommon or domain-specific words.
  • Makes website spellcheck results more focused and maintainable without changing documentation content. ✅

The rare dictionary maps valid words manger->manager and trough->through,
producing false positives on the LVIS class label manger/trough. Removing
rare fixes the source rather than adding ignore-list exceptions, while
retaining clear, informal, and en-GB_to_en-US checks.

Ref: ultralytics#340
@UltralyticsAssistant UltralyticsAssistant added devops GitHub Devops or MLops documentation Improvements or additions to documentation labels Jul 18, 2026
@UltralyticsAssistant

Copy link
Copy Markdown
Member

👋 Hello @JaviChulvi, thank you for submitting a ultralytics/docs 🚀 PR! 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 by writing "I have read the CLA Document and I sign the CLA" in a new message.
  • 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. This review is automated, and an engineer will assist if needed. 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

Clean, minimal workflow-only change. Removing rare from the Codespell built-in dictionaries preserves the existing spellcheck invocation and ignore rules while narrowing the dictionary set as intended.

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

Labels

devops GitHub Devops or MLops documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Remove codespell rare dictionary from website spellcheck

2 participants