Fix spell check false positive #176
Merged
Conversation
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
The "codespell" tool is used to check for commonly misspelled words in the project files. As part of a recent update, "indx" was added to the misspelled words dictionary as a misspelling of "index". The project contains a variable named "indx", so the spell check started failing following that update. Although it is questionable whether using a variable name that is shortened from the related correct word by only a single letter, it is also not objectively wrong. Since it is believed that this was an intentional choice by the developer, the spell check failure can be considered spurious. In this case, the correct resolution is to configure codespell to ignore this word.
per1234
added
type: imperfection
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.
The "codespell" tool is used to check for commonly misspelled words in the project files.
As part of a recent update, "indx" was added to the misspelled words dictionary as a misspelling of "index". The project contains a variable named "indx", so the spell check started failing following that update. Although it is questionable whether using a variable name that is shortened from the related correct word by only a single letter, it is also not objectively wrong. Since it is believed that this was an intentional choice by the developer, the spell check failure can be considered spurious. In this case, the correct resolution is to configure codespell to ignore this word.