Skip to content

Commit 6d9ca68

Browse files
authored
Fix spell check ~false positive by ignoring word (#22)
In the latest release of the codespell tool used for automated spell checking of the files of this project, the word "inflight" was added to the codespell misspelled words dictionary as a misspelling of "in-flight". The "inflight" spelling occurs in a comment in `src/utility/MQTTClient.h`, which caused the spell check to start failing. Although that is surely correct for the prose word, "inflight" seems to be somewhat common in the context of MQTT, and also occurs in names in the code, so I'm not sure that "correcting" the current spelling would be the right thing to do. It is also probably questionable whether this file should be edited at all, since it appears it might be an externally maintained resource (meaning that any changes to it in this repo make a hypothetical sync from upstream more difficult). All in all, it seems best to simply configure codespell to ignore the problematic word.
1 parent 96fe0dc commit 6d9ca68

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

.codespellrc

+1-1
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 = tre,messanger
4+
ignore-words-list = inflight,tre,messanger
55
check-filenames =
66
check-hidden =
77
skip = ./.git

0 commit comments

Comments
 (0)