Update the README.rst with the ignore-path option

Also update the option parser to set the metavar
for the new ignore-path argument to 'path' (instead of
the default of 'IGNORE_PATH' which the option parser
generates automatically).

Change-Id: I13c845c13f4b80511dc4d5b179ba80030e8b9972
This commit is contained in:
Joshua Harlow 2014-08-13 07:47:00 -07:00
parent 4861c486e8
commit 857f5feaff
2 changed files with 7 additions and 3 deletions

View File

@ -26,9 +26,10 @@ Usage
::
$ ./doc8 -h
$ doc8 -h
usage: doc8 [-h] [--config path] [--allow-long-titles] [--ignore code]
[--max-line-length int] [-e extension]
[--ignore-path path] [--max-line-length int] [-e extension]
[path [path ...]]
Check documentation for simple style requirements.
@ -53,6 +54,8 @@ Usage
pep8.ini, setup.cfg)
--allow-long-titles allow long section titles (default: False)
--ignore code ignore the given errors code/codes
--ignore-path path
ignore the given directory or file
--max-line-length int
maximum allowed line length (default: 79)
-e extension, --extension extension

View File

@ -145,7 +145,8 @@ def main():
type=split_set_type,
default=[])
parser.add_argument("--ignore-path", action="append", default=[],
help="ignore the given directory or file")
help="ignore the given directory or file",
metavar='path')
parser.add_argument("--max-line-length", action="store", metavar="int",
type=int,
help="maximum allowed line"