Add typos as a pre-commit hook
#2700
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
CI
github-actions
bot
added
docs
|
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
github-actions
bot
added
plasmapy.plasma
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #2700 +/- ##
=======================================
Coverage 95.25% 95.25%
=======================================
Files 104 104
Lines 9435 9435
Branches 2159 2159
=======================================
Hits 8987 8987
Misses 272 272
Partials 176 176 ☔ View full report in Codecov by Sentry. |
github-actions
bot
added
the
maintenance
nabobalis
reviewed
May 24, 2024
_typos.toml
Outdated
| @@ -0,0 +1,19 @@ | |||
| [default] | |||
| extend-ignore-identifiers-re = [ | |||
nabobalis
reviewed
May 24, 2024
|
|
||
| [default.extend-words] | ||
| aas = "aas" | ||
| arange = "arange" |
There was a problem hiding this comment.
This was such an annoying thing to have to add to our config as well.
nabobalis
approved these changes
May 24, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR tries out typos as a pre-commit hook as a possible addition to or replacement for codespell. It managed to find a couple more typos. Since it's written in Rust, it's probably quicker (though I didn't time it).
I'll tentatively add this as a hook without removing codespell, but we can consider removing one of them later if it gets annoying to have to deal with both.
Thanks to @nabobalis for suggesting this!