Skip to content

Commit 8eed350

Browse files
committed
ENH: Clarify --dict help string, and support --ignore-words and -I alternative
This is intended to streamline the integration of project already using the checker provided by "codespell-project".
1 parent 1d99588 commit 8eed350

1 file changed

Lines changed: 3 additions & 2 deletions

File tree

codespell.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -215,9 +215,10 @@ def parse_args():
215215
parser.add_argument('--vim', '-V', action='store_true', default=False,
216216
dest='vim', help='Output results in vim command format')
217217

218-
parser.add_argument('--dict', '-d', action='append',
218+
parser.add_argument('--dict', '-d', '--ignore-words', '-I', action='append',
219219
dest='dict',
220-
help='Add a dictionary (multiples allowed)')
220+
help='File that contains words that will be ignored (multiples allowed).'
221+
' File must contain 1 word per line.')
221222

222223
parser.add_argument('--exclude', '-e', action='append',
223224
dest='exclude',

0 commit comments

Comments
 (0)