Skip to content

Commit 4d0ee96

Browse files
authored
Fix spellcheck false positive
The codespell spellchecker tool is used to detect occurrences of commonly misspelled words in the project files. The project readme references the acronym "ALS" (ambient light sensor). This happens to be in the codespell misspelled word dictionary as a misspelling of "also", and so causes a failure of the spellcheck. The false positive is resolved by adding the word to the ignore list in the codespell configuration.
1 parent fd22543 commit 4d0ee96

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
@@ -2,7 +2,7 @@
22
# See: https://github.com/codespell-project/codespell#using-a-config-file
33
[codespell]
44
# In the event of a false positive, add the problematic word, in all lowercase, to a comma-separated list here:
5-
ignore-words-list = ,
5+
ignore-words-list = als
66
skip = ./.licenses,.git,__pycache__,node_modules,go.mod,go.sum,package-lock.json,poetry.lock,yarn.lock
77
builtin = clear,informal,en-GB_to_en-US
88
check-filenames =

0 commit comments

Comments
 (0)