Add codespell support (config, workflow to detect/not fix) and make it fix some typos#951
Open
yarikoptic wants to merge 3 commits into
Open
Add codespell support (config, workflow to detect/not fix) and make it fix some typos#951yarikoptic wants to merge 3 commits into
yarikoptic wants to merge 3 commits into
Conversation
…os automagically
=== Do not change lines below ===
{
"chain": [],
"cmd": "codespell -w",
"exit": 0,
"extra_inputs": [],
"inputs": [],
"outputs": [],
"pwd": "."
}
^^^ Do not change lines above ^^^
Member
|
can you attach a full run with these settings against the existing docs ? or are they all clean other than the fixes you included ? |
Author
yes, after those few fixes, it was all clean here as codespell workflow noted in its run: |
Member
|
sounds great. we'll look at running codespell internally on these files, and then circle back to enabling this here. |
Member
|
i've queued up fixes internally for the various guides and will circle back once they land |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
More about codespell: https://github.com/codespell-project/codespell .
I personally introduced it to dozens if not hundreds of projects already and so far only positive feedback.
CI workflow has 'permissions' set only to 'read' so also should be safe.
It was requested a while back in
and recommended in
there indeed could be some false positives but I think it is quite robust -- you can see how few I had to exclude, and some of those could actually be "fixed" to make it cleaner