Add documentation for spell check #83
Conversation
|
Fixes #odk-x/tool-suite-X#247 |
| @@ -341,6 +341,18 @@ specify the check name in the check list | |||
| in the function :py:func:`exclude_checks` | |||
| in the file :file:`style-test.py`. | |||
|
|
|||
| Excluding Spelling checks | |||
There was a problem hiding this comment.
Capitalization is uneven here. Also a bit confusing "Excluding spelling checks." Maybe instead "Excluding specific words from the spelling check" or something similar. You aren't canceling the whole check.
| Excluding Spelling checks | ||
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| To exclude a word from spelling check,specify the word under the title spelling on the top of the document. |
There was a problem hiding this comment.
missing a space between check, and specify. Also should be a "the" before spelling check. "At" not "on" the top of the document.
There was a problem hiding this comment.
I agree with @elmps2018 it makes sense to document how to add words locally (in the file) and globally in all files.
FYI... You can add the word to https://github.com/odk-x/docs/blob/master/odkx-src/spelling_wordlist.txt and the spell checker will recognize it and not report an error.
Documentation to exclude a word from spelling check is added.
fix odk-x/tool-suite-X#247