Skip to content

Commit

Permalink
Add hints for adding new words to the dictionary
Browse files Browse the repository at this point in the history
  • Loading branch information
Qrox committed Apr 9, 2024
1 parent f45da55 commit 7fff673
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions tools/spell_check_pr.py
Original file line number Diff line number Diff line change
Expand Up @@ -39,3 +39,26 @@
" this is inaccurate, or (optionally) you can also add the new words"
" to `tools/spell_checker/dictionary.txt` so they will not trigger "
"an alert next time.")
print()
print("<details>")
print("<summary>Hints for adding a new word to the dictionary</summary>")
print("If the word is normally in all lowercase, such as the noun `word` "
"or the verb `does`, add it in its lower-case form; if the word is "
"a proper noun, such as the surname `George`, add it in its "
"initial-caps form; if the word is an acronym or has special letter "
"case, such as the acronym `CDDA` or the unit `mW`, add it by "
"preserving the case of all the letters. A word in the dictionary "
"will also match its initial-caps form (if the word is in all "
"lowercase) and all-uppercase form, so a word should be added to "
"the dictionary in its normal letter case even if used in a "
"different letter case in a sentence.")
print()
priont("For a word to be added to the dictionary, it should either be a "
"real, properly-spelled modern American English word, a foreign "
"loan word (including romanized foreign names), or a foreign or "
"made-up word that is used consistently and commonly enough in the "
"game. Intentional misspelling (including eye dialect) of a word "
"should not be added unless it has become a common terminology in "
"the game, because while someone may have a legitimate use for it, "
"another person may spell it that way accidentally.")
print("</details>")

0 comments on commit 7fff673

Please sign in to comment.