Add codespell checker for common spelling mistakes #558
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
|
@mfisher87, you should now be able to merge in recent changes from |
This directory was being created when I run pre-commit, and inside was empty except `.cache/prettier`. Why is it happening? Not sure, but more important is to prevent it from being committed if it happens to someone else.
Notebooks are JSON data structures under the hood, and they include baked-in output of Python code. This means: * Images rendered may include random strings detected as "words" by codespell, e.g. `/te+/` was detected as `te`, which codespell reported as a misspelling of `the`, `be`, `we`, or `to`. * Arbitrary output from Python code may contain legitimate misspellings or things that look like misspellings to codespell. E.g. `dout` may be considered a misspelling of `doubt`. We can't control this output. This file is generated and we have no control over it. * Package names, e.g. `astroid`, that we don't directly depend on, may trigger spelling errors. FWIW, "astroid" is a word, I just don't think we'll want to use it in our codebase, so it should be caught if we do. * Packages we depend on may include spelling errors in their metadata, e.q. `pqdm` spells "parallelization" incorrectly in its description.
|
@chuckwondo apologies, should have marked this as draft before now :) |
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.
TODO: Fix errors