codespell-project/codespell
1
0
Fork 0
mirror of https://github.com/codespell-project/codespell.git synced 2025-08-06 09:40:56 +08:00
Code Issues Packages Projects Releases Wiki Activity

Further elaborate on codespell -I in --help output

Browse Source 
Also includes a format refinement to README.rst
This commit is contained in:
Unknown
2017-10-09 11:05:38 -04:00
parent 74a8178dcc
commit b78dcae830
2 changed files with 4 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
README.rst
View File

@ -51,7 +51,7 @@ Comma-separated list of files to skip. It accepts globs as well. Examples:
codespell -I FILE, --ignore-words=FILE
This flag can be used to whitelist certain words that are in the ``codespell_lib/data/dictionary.txt``. The format of the whitelist file is one word per line. Invoke using: ``codespell -I path/to/file.txt`` to execute codespell referencing said whitelist. **Important note:** The whitelist passed to ``-I`` is case-sensitive based on how it is listed in dictionary.txt.
This flag can be used to whitelist certain words that are in the ``codespell_lib/data/dictionary.txt``. The format of the whitelist file is one word per line. Invoke using: ``codespell -I path/to/file.txt`` to execute codespell referencing said whitelist. **Important note:** The whitelist passed to ``-I`` is case-sensitive based on how it is listed in ``dictionary.txt``.
Useful commands::

4
codespell_lib/_codespell.py
View File

@ -226,7 +226,9 @@ def parse_options(args):
parser.add_option('-I', '--ignore-words',
action='append', metavar='FILE',
help='File that contains words which will be ignored '
'by codespell.')
'by codespell. File must contain 1 word per line.'
'Words are case sensitive based on how they are '
'written in codespell_lib/data/dictionary.txt')
parser.add_option('-r', '--regex',
action='store', type='string',
help='Regular expression which is used to find words. '