Skip to content

Commit 3f1a768

Browse files
committed
fix documentation
1 parent cbd5b2f commit 3f1a768

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Assuming your project follows a layout like the suggested `sample project`_::
2323
Basic usage, running in your project directory::
2424

2525
<activate virtualenv for your project>
26-
pip-missing-reqs --ignore-files=sample/tests/* sample
26+
pip-missing-reqs --ignore-file=sample/tests/* sample
2727

2828
This will find all imports in the code in "sample" and check that the
2929
packages those modules belong to are in the requirements.txt file.
@@ -36,7 +36,7 @@ To make your life easier, copy something like this into your tox.ini::
3636

3737
[pip-missing-reqs]
3838
deps=-rrequirements.txt
39-
commands=pip-missing-reqs --ignore-files=sample/tests/* sample
39+
commands=pip-missing-reqs --ignore-file=sample/tests/* sample
4040

4141

4242
Excluding test files (or others) from this check
@@ -47,19 +47,19 @@ application source ("sample" in the above examples). The requirements for
4747
those tests generally should not be in the requirements.txt file, and you
4848
don't want this tool to generate false hits for those.
4949

50-
You may exclude those test files from your check using the --ignore-files
51-
option.
50+
You may exclude those test files from your check using the `--ignore-file`
51+
option (shorthand is `-f`). Multiple instances of the option are allowed.
5252

5353

5454
Excluding modules from the check
5555
--------------------------------
5656

5757
If your project has modules which are conditionally imported, or requirements
5858
which are conditionally included, you may exclude certain modules from the
59-
check by name (or glob pattern) using --ignore-mods::
59+
check by name (or glob pattern) using `--ignore-module` (shorthand is `-m`)::
6060

6161
# ignore the module spam
62-
pip-missing-reqs --ignore-mods=spam sample
62+
pip-missing-reqs --ignore-module=spam sample
6363
# ignore the whole package spam as well
64-
pip-missing-reqs --ignore-mods=spam --ignore-mods=spam.* sample
64+
pip-missing-reqs --ignore-module=spam --ignore-module=spam.* sample
6565

0 commit comments

Comments
 (0)