Skip to content

Ignore codespell false positive on "wasn't" contraction#323

Merged
glenn-jocher merged 1 commit into
mainfrom
codespell-ignore-wasn
Jun 28, 2026
Merged

Ignore codespell false positive on "wasn't" contraction#323
glenn-jocher merged 1 commit into
mainfrom
codespell-ignore-wasn

Conversation

@glenn-jocher

@glenn-jocher glenn-jocher commented Jun 28, 2026

Copy link
Copy Markdown
Member

Problem

The scheduled Website links and spellcheck workflow is failing on www.ultralytics.com with:

www.ultralytics.com/glossary/model-monitoring  wasn ==> wasn't, was
www.ultralytics.com/glossary/multimodal-rag    wasn ==> wasn't, was

This is a false positive. The source text is the correct contraction "wasn't" (verified in the CMS — …data it wasn't trained on.). The spellcheck step runs codespell over the crawled rendered HTML, where the apostrophe is the HTML entity ' (wasn't). codespell doesn't decode HTML entities, so it tokenizes wasn as a standalone word and matches its wasn ==> wasn't, was dictionary entry.

Fix

Add wasn't,wasn to the codespell --ignore-words-list, mirroring the existing couldn't,couldn entry already in that list for the exact same entity-encoded-apostrophe case. No content change — the live text is already correct.

🛠️ PR Summary

Made with ❤️ by Ultralytics Actions

🌟 Summary

🛠️ This PR updates the docs repository’s link and spell-check workflow to ignore a few additional valid contractions, reducing false-positive spelling errors in CI.

📊 Key Changes

  • Added wasn't and wasn to the --ignore-words-list in .github/workflows/links.yml.
  • Kept the existing spell-check and link-check workflow intact, with only a small adjustment to the ignored words list.
  • Improved handling of informal or contracted language that may appear in documentation content.

🎯 Purpose & Impact

  • ✅ Reduces unnecessary CI warnings or failures caused by valid wording in docs.
  • 🧹 Helps maintainers focus on real spelling and link issues instead of false alarms.
  • 🚀 Makes the documentation workflow smoother and more reliable for contributors updating content.

The website spellcheck runs codespell over the crawled rendered HTML, where
apostrophes are HTML entities (`wasn't`). codespell can't decode the
entity, so it tokenizes "wasn" and reports `wasn ==> wasn't, was` on
www.ultralytics.com/glossary/model-monitoring and /multimodal-rag — even
though the source text is the correct "wasn't". Add `wasn't,wasn` to the
ignore list, mirroring the existing `couldn't,couldn` entry for the same
entity-encoded-apostrophe case.
@UltralyticsAssistant UltralyticsAssistant added devops GitHub Devops or MLops fixed Bug has been resolved priority: low Low urgency; can wait behind higher-priority work. labels Jun 28, 2026
@UltralyticsAssistant

Copy link
Copy Markdown
Member

👋 Hello @glenn-jocher, thank you for submitting a ultralytics/docs 🚀 PR! This is an automated message to help streamline review, and an engineer will assist you shortly 😊 Please review the checklist below to help ensure smooth integration:

  • 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. 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 change. The update is narrowly scoped, consistent with the existing handling for contractions like couldn't/couldn, and I don't see any functional or maintainability issues in this diff.

@glenn-jocher glenn-jocher merged commit 1fca559 into main Jun 28, 2026
5 checks passed
@glenn-jocher glenn-jocher deleted the codespell-ignore-wasn branch June 28, 2026 21:10
@UltralyticsAssistant

Copy link
Copy Markdown
Member

Merged! 🎉 Thanks, @glenn-jocher, for this thoughtful cleanup to the docs workflow.

As Benjamin Franklin said, “An ounce of prevention is worth a pound of cure.” This small update does exactly that by reducing false-positive spell-check noise so contributors and maintainers can stay focused on real issues that improve documentation quality.

Really appreciate the attention to detail here — changes like this make the docs experience smoother for everyone.

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 priority: low Low urgency; can wait behind higher-priority work.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants