Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Commit ae7b55c

Browse files
committed
Fix spell check false positive
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.
1 parent e5438e2 commit ae7b55c

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

‎.codespellrc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# See: https://github.com/codespell-project/codespell#using-a-config-file
22
[codespell]
33
# In the event of a false positive, add the problematic word, in all lowercase, to a comma-separated list here:
4-
ignore-words-list = ,
4+
ignore-words-list = indx
55
check-filenames =
66
check-hidden =
77
skip = ./.git

0 commit comments

Comments
(0)

AltStyle によって変換されたページ (->オリジナル) /