Skip to content

Commit ce1372e

Browse files
authored
Merge pull request #32 from jcfr/improve-cli-argument-descriptions
ENH: Update argument help strings to clarify meaning of "multiple"
2 parents b3ddf9c + bf99166 commit ce1372e

1 file changed

Lines changed: 9 additions & 6 deletions

File tree

codespell.py

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -257,7 +257,8 @@ def parse_args():
257257
"-I",
258258
action="append",
259259
dest="dict",
260-
help="File that contains words that will be ignored (multiples allowed)."
260+
help="File that contains words that will be ignored."
261+
" Argument can be passed multiple times."
261262
" File must contain 1 word per line.",
262263
)
263264

@@ -266,17 +267,19 @@ def parse_args():
266267
"-e",
267268
action="append",
268269
dest="exclude",
269-
help="Specify regex for excluding files (multiples allowed)",
270+
help="Specify regex for excluding files."
271+
" Argument can be passed multiple times.",
270272
)
271273

272274
parser.add_argument(
273275
"--skip",
274276
"-S",
275277
action="append",
276-
help="comma-separated list of files to skip. It "
278+
help="Comma-separated list of files to skip. It "
277279
"accepts globs as well. E.g.: if you want "
278280
"codespell to skip .eps and .txt files, "
279-
'you\'d give "*.eps,*.txt" to this option.',
281+
'you\'d give "*.eps,*.txt" to this option.'
282+
" Argument can be passed multiple times.",
280283
)
281284

282285
parser.add_argument(
@@ -285,7 +288,7 @@ def parse_args():
285288
action="append",
286289
default=[],
287290
dest="prefixes",
288-
help="Add word prefix (multiples allowed)",
291+
help="Add word prefix. Argument can be passed multiple times.",
289292
)
290293

291294
parser.add_argument(
@@ -303,7 +306,7 @@ def parse_args():
303306
action="append",
304307
default=[".h"],
305308
dest="suffix",
306-
help="File name suffix",
309+
help="File name suffix. Argument can be passed multiple times.",
307310
)
308311

309312
parser.add_argument(

0 commit comments

Comments
 (0)