Skip to content

Ignore TOOD in website spellcheck - #378

Closed
nastijakh wants to merge 1 commit into
mainfrom
codespell-ignore-tood
Closed

nastijakh wants to merge 1 commit into
mainfrom
codespell-ignore-tood

Conversation

@nastijakh

@nastijakh nastijakh commented Nov 2, 2026 •

Copy link
Copy Markdown
Collaborator

Summary

Test plan

  • Ran codespell locally on a sample line: TOOD is flagged without the updated list and passes with it.

🤖 Generated with Claude Code

🛠️ PR Summary

Made with ❤️ by Ultralytics Actions

🌟 Summary

Added TOOD to the website spellcheck’s ignored-word list so the detector name is not flagged as a typo.

📊 Key Changes

  • Updated the codespell --ignore-words-list in .github/workflows/links.yml to include TOOD.

🎯 Purpose & Impact

  • The website spellcheck no longer flags TOOD as a misspelling; no website content or runtime behavior changed.

TOOD (Task-aligned One-stage Object Detection) is a real detector name on the anchor-free detectors glossary page.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@UltralyticsAssistant UltralyticsAssistant added the devops GitHub Devops or MLops label Nov 2, 2026
@UltralyticsAssistant

Copy link
Copy Markdown
Member

👋 Hello @nastijakh, 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 codespell ignore-list change in .github/workflows/links.yml. Adding TOOD is scoped to the existing spellcheck configuration and addresses the reported false positive. LGTM.

@glenn-jocher

Copy link
Copy Markdown
Member

Thanks @nastijakh! This exact change (adding TOOD to the codespell ignore list) already landed on main in #380, so I'm closing this as superseded.

@glenn-jocher
glenn-jocher deleted the codespell-ignore-tood branch November 4, 2026 09:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

devops GitHub Devops or MLops

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants