Skip to content

Ignore TOOD detector name in website spellcheck - #380

Merged
glenn-jocher merged 1 commit into
mainfrom
spellcheck-ignore-tood
Nov 2, 2026
Merged

glenn-jocher merged 1 commit into
mainfrom
spellcheck-ignore-tood

Conversation

@glenn-jocher

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

Copy link
Copy Markdown
Member

The nightly website check (run 41404543953) flags `TOOD ==> TODO` on www.ultralytics.com/glossary/anchor-free-detectors. TOOD (Task-aligned One-stage Object Detection) is a real detector name, so this is a false positive, like the proper names handled in #377.

Adds `TOOD` to codespell's ignore list. Uppercase entries are matched case-sensitively, so a lowercase `tood` typo is still flagged.

Validated with codespell 2.4.3 on the live page: `TOOD` is no longer reported, and a test file containing `tood` still fails.

🛠️ PR Summary

Made with ❤️ by Ultralytics Actions

🌟 Summary

Added TOOD to the website spellcheck ignore list to prevent the detector name from being flagged as a typo.

📊 Key Changes

  • Updated the codespell ignore-word list in the links workflow to include uppercase TOOD.
  • Kept lowercase tood outside the ignore list, so it remains subject to spellchecking.

🎯 Purpose & Impact

  • Prevents a false positive for TOOD on the anchor-free detectors glossary page; no website content or user-facing behavior changed.

@UltralyticsAssistant UltralyticsAssistant added devops GitHub Devops or MLops documentation Improvements or additions to documentation labels Nov 2, 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 .github/workflows/links.yml codespell ignore-list change. It adds TOOD without changing the surrounding check behavior. LGTM.

@glenn-jocher
glenn-jocher merged commit 35be08e into main Nov 2, 2026
6 checks passed
@glenn-jocher
glenn-jocher deleted the spellcheck-ignore-tood branch November 2, 2026 23:08
@UltralyticsAssistant

Copy link
Copy Markdown
Member

🎉 This PR has been merged—thanks, @glenn-jocher! Adding uppercase TOOD to the spellcheck ignore list prevents a false positive while keeping lowercase tood checked.

“Alone we can do so little; together we can do so much.” — Helen Keller

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.

2 participants