Ignore codespell false positive on "wasn't" contraction#323
Conversation
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.
|
👋 Hello @glenn-jocher, thank you for submitting a
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
left a comment
There was a problem hiding this comment.
🔍 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.
|
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. |
Problem
The scheduled Website links and spellcheck workflow is failing on
www.ultralytics.comwith: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 tokenizeswasnas a standalone word and matches itswasn ==> wasn't, wasdictionary entry.Fix
Add
wasn't,wasnto the codespell--ignore-words-list, mirroring the existingcouldn't,couldnentry 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
wasn'tandwasnto the--ignore-words-listin.github/workflows/links.yml.🎯 Purpose & Impact