Skip to content

Ignore Hailo .alls extension in spellcheck#322

Merged
glenn-jocher merged 1 commit into
mainfrom
fix-codespell-alls-extension
Jun 27, 2026
Merged

Ignore Hailo .alls extension in spellcheck#322
glenn-jocher merged 1 commit into
mainfrom
fix-codespell-alls-extension

Conversation

@glenn-jocher

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

Copy link
Copy Markdown
Member

🛠️ PR Summary

Made with ❤️ by Ultralytics Actions

🌟 Summary

🛠️ This PR fine-tunes the docs link/spell-check workflow by ignoring .alls matches in codespell, reducing false-positive spelling errors during CI.

📊 Key Changes

  • Added --ignore-regex '\.alls\b' to the codespell command in .github/workflows/links.yml.
  • This updates the GitHub Actions validation workflow used when checking generated HTML files.
  • The change specifically tells spell-checking to skip text patterns matching .alls, which were likely being flagged incorrectly.

🎯 Purpose & Impact

  • ✅ Reduces noisy CI failures caused by false-positive spell-check results.
  • 🚀 Makes documentation checks more reliable, so contributors can focus on real issues instead of workflow quirks.
  • 🧹 Helps streamline pull request reviews and docs maintenance in ultralytics/docs.
  • 👩‍💻 Improves contributor experience by preventing unnecessary spell-check troubleshooting.

@UltralyticsAssistant UltralyticsAssistant added devops GitHub Devops or MLops documentation Improvements or additions to documentation fixed Bug has been resolved labels Jun 27, 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 while an engineer assists with your PR. Please review the checklist below:

  • 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 added codespell ignore is narrowly scoped to the Hailo .alls extension and does not appear to weaken the existing spellcheck coverage in any meaningful way.

@glenn-jocher glenn-jocher merged commit 6c47009 into main Jun 27, 2026
5 checks passed
@glenn-jocher glenn-jocher deleted the fix-codespell-alls-extension branch June 27, 2026 21:01
@UltralyticsAssistant

Copy link
Copy Markdown
Member

Merged! 🎉 Thanks, @glenn-jocher, for this thoughtful workflow improvement.

As Benjamin Franklin said, “An ounce of prevention is worth a pound of cure.” This update is a great example of that in action—by filtering out .alls false positives in codespell, it reduces noisy CI failures and helps keep docs validation focused on real issues.

Really appreciate the attention to detail here. Small refinements like this make the contributor experience smoother and the ultralytics/docs pipeline more reliable 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 documentation Improvements or additions to documentation fixed Bug has been resolved

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants