Skip to content

Commit 55a6639

Browse files
committed
Update help
1 parent faa07da commit 55a6639

File tree

2 files changed

+7
-3
lines changed

2 files changed

+7
-3
lines changed

docs/src/markdown/index.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,8 @@ If you want to manually install it, run `#!bash python setup.py build` and `#!ba
5353
## Command Line Usage
5454

5555
```
56-
usage: pyspelling [-h] [--version] [--verbose] [--name NAME | --group GROUP] [--binary BINARY] [--jobs JOBS] [--config CONFIG] [--source SOURCE] [--spellchecker SPELLCHECKER] [--skip-dict-compile]
56+
usage: pyspelling [-h] [--version] [--verbose] [--name NAME | --group GROUP] [--binary BINARY] [--jobs JOBS] [--config CONFIG] [--source SOURCE]
57+
[--spellchecker SPELLCHECKER] [--skip-dict-compile]
5758
5859
Spell checking tool.
5960
@@ -64,7 +65,7 @@ options:
6465
--name, -n NAME Specific spelling task by name to run.
6566
--group, -g GROUP Specific spelling task group to run.
6667
--binary, -b BINARY Provide path to spell checker's binary.
67-
--jobs, -j JOBS Specify the number of spell checker processes to run in parallel.
68+
--jobs, -j JOBS Specify the number of spell checker processes to run in parallel. Using 0 will utilize the maximum number of cores.
6869
--config, -c CONFIG Spelling config.
6970
--source, -S SOURCE Specify override file pattern. Only applicable when specifying exactly one --name.
7071
--spellchecker, -s SPELLCHECKER

pyspelling/__main__.py

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,10 @@ def main():
2121
action='store',
2222
type=int,
2323
default=None,
24-
help="Specify the number of spell checker processes to run in parallel."
24+
help=(
25+
"Specify the number of spell checker processes to run in parallel. "
26+
"Using 0 will utilize the maximum number of cores."
27+
)
2528
)
2629
parser.add_argument('--config', '-c', action='store', default='', help="Spelling config.")
2730
parser.add_argument(

0 commit comments

Comments
 (0)