Skip to content

Commit 38a60a6

Browse files
committed
Explain some allowlist entries in typos.toml
1 parent e8bdcb0 commit 38a60a6

1 file changed

Lines changed: 11 additions & 11 deletions

File tree

typos.toml

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -20,24 +20,24 @@ extend-exclude = [
2020
# right now. Entries should look like `mipsel = "mipsel"`.
2121
#
2222
# tidy-alphabetical-start
23-
arange = "arange"
23+
arange = "arange" # short for A-range
2424
childs = "childs"
2525
clonable = "clonable"
26-
filetimes = "filetimes"
26+
filetimes = "filetimes" # short for "file times", not a typo for "lifetimes"
2727
leafs = "leafs"
28-
makro = "makro"
28+
makro = "makro" # deliberate misspelling to avoid `macro` keyword
2929
misformed = "misformed"
3030
moreso = "moreso"
31-
numer = "numer"
32-
optin = "optin"
31+
numer = "numer" # short for numerator, not a typo for "number"
32+
optin = "optin" # short for opt-in
3333
publically = "publically"
34-
rplace = "rplace"
34+
rplace = "rplace" # short for R-place
3535
splitted = "splitted"
36-
taits = "taits"
36+
taits = "taits" # lowercase for TAITs (type alias impl trait)
3737
targetting = "targetting"
3838
unparseable = "unparseable"
3939
unstability = "unstability"
40-
unstalled = "unstalled"
40+
unstalled = "unstalled" # short for un-stalled
4141
# tidy-alphabetical-end
4242

4343
# Denylist to forbid misspelled words that aren't detected by the built-in
@@ -65,14 +65,14 @@ ERROR_MCA_OCCURED = "ERROR_MCA_OCCURED"
6565
ERROR_REQ_NOT_ACCEP = "ERROR_REQ_NOT_ACCEP"
6666
EnzymeTypeTreeShiftIndiciesEq = "EnzymeTypeTreeShiftIndiciesEq"
6767
EnzymeTypeTreeShiftIndiciesEqFn = "EnzymeTypeTreeShiftIndiciesEqFn"
68-
Oppen = "Oppen"
68+
Oppen = "Oppen" # Derek C. Oppen, author of "Pretty Printing" (1979)
6969
# typos treats this as two different camelcase words (`SETTIN` and `Gs`)
7070
# Tracked in: https://github.com/crate-ci/typos/issues/745
7171
SETTINGs = "SETTINGs"
72-
debug_aranges = "debug_aranges"
72+
debug_aranges = "debug_aranges" # debug A-ranges
7373
key_smove = "key_smove" # shifted move key, used by terminfo
7474
shift_indicies_eq = "shift_indicies_eq"
75-
tolen = "tolen"
75+
tolen = "tolen" # length of "to" buffer, used by `sendto` in Windows sockets
7676
# tidy-alphabetical-end
7777

7878
[default]

0 commit comments

Comments
 (0)