Skip to content

Add spellchecking action#865

Merged
KnutAM merged 17 commits intomasterfrom
kam/typos
Mar 10, 2026
Merged

Add spellchecking action#865
KnutAM merged 17 commits intomasterfrom
kam/typos

Conversation

@KnutAM
Copy link
Copy Markdown
Member

@KnutAM KnutAM commented Jan 5, 2024

It does find a few mistakes around, see https://github.com/Ferrite-FEM/Ferrite.jl/actions/runs/7427267344/job/20212641841 (Edit: fixed in #866)
But seems somewhat fragile as I had to add quite some exceptions.
On the other hand, since it should only run on pull requests it won't indicate CI failure even if not fixed.

@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented Jan 5, 2024

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 94.25%. Comparing base (a347761) to head (2a9e0ed).
⚠️ Report is 3 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #865   +/-   ##
=======================================
  Coverage   94.25%   94.25%           
=======================================
  Files          40       40           
  Lines        6757     6757           
=======================================
  Hits         6369     6369           
  Misses        388      388           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@termi-official termi-official mentioned this pull request Nov 8, 2024
@termi-official
Copy link
Copy Markdown
Member

Since typos seem to sneak in regularly I would say lets add this to the CI to catch typos early on.

Comment thread .github/workflows/SpellCheck.yml Outdated
Comment thread .github/workflows/SpellCheck.yml Outdated
KnutAM and others added 2 commits March 9, 2026 20:27
Co-authored-by: Dennis Ogiermann <termi-official@users.noreply.github.com>
Co-authored-by: Dennis Ogiermann <termi-official@users.noreply.github.com>
Comment thread .typos.toml Outdated
Comment thread .typos.toml
Comment thread .typos.toml Outdated
@KnutAM KnutAM marked this pull request as ready for review March 10, 2026 16:43
Copy link
Copy Markdown
Member

@termi-official termi-official left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the .typos.toml is sufficiently easy to find (and remember) that we do not need any additional documentation for that.

@KnutAM KnutAM merged commit 2ecfdd4 into master Mar 10, 2026
17 checks passed
@KnutAM KnutAM deleted the kam/typos branch March 10, 2026 19:57
@KnutAM
Copy link
Copy Markdown
Member Author

KnutAM commented Mar 10, 2026

If this gets too annoying then it can easily be removed, but this should reduce review work a bit

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants