Skip avatar-fallback initials in codespell check#308
Conversation
|
👋 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
The change looks clean. Extending the existing HTML preprocessing step to remove data-slot="avatar-fallback" content is consistent with the current approach and should reduce codespell false positives without introducing any obvious workflow or logic issues in the diff shown.
|
Merged! 🎉 Thanks, @glenn-jocher, for this thoughtful docs CI improvement. As Thomas Edison said, “There’s a way to do it better—find it.” This update is a great example of that mindset: a small, targeted fix that removes noisy false positives, keeps spellcheck focused on real issues, and makes docs maintenance smoother for everyone. Really appreciate the practical attention to detail here—changes like this quietly improve the contributor experience in a big way. |
Summary
The daily
Website links and spellcheckworkflow has been failing because codespell flags contributor initials rendered inside avatar fallbacks (e.g.BUforBurhan-Q,TE) as misspellings on every docs page that has a Contributors section.These initials are auto-generated presentational text, not prose. Extends the existing
<script>/<style>strip pass to also remove<*data-slot=\"avatar-fallback\">…</*>elements before running codespell. Same pattern, same line.This is a permanent fix — any future contributor with an unfortunate two-letter initial pair is handled automatically, so we don't keep growing
--ignore-words-listevery time a new contributor lands. (The existing list already has a number of suspicious 2–3 letter entries likend, ned, ane, nam, nin, fo, orethat look like prior patches around this same issue and can probably be cleaned up in a follow-up once this run goes green.)Test plan
🛠️ PR Summary
Made with ❤️ by Ultralytics Actions
🌟 Summary
🧹 Improves the docs link-check workflow by removing auto-generated avatar fallback text from HTML before spellchecking, reducing false-positive typo reports.
📊 Key Changes
.github/workflows/links.ymlin the docs CI workflow.codespell.<script>and<style>content, and now also removes elements withdata-slot="avatar-fallback"."BU"can be incorrectly flagged as spelling mistakes.🎯 Purpose & Impact