Adjust usage doc for new extension argument
This commit is contained in:
parent
85543ce0a1
commit
44e052ae77
19
README.rst
19
README.rst
|
@ -28,6 +28,7 @@ Usage
|
|||
|
||||
$ ./doc8 -h
|
||||
usage: doc8 [-h] [--config path] [--allow-long-titles] [--ignore code]
|
||||
[--max-line-length int] [-e extension]
|
||||
[path [path ...]]
|
||||
|
||||
Check documentation for simple style requirements.
|
||||
|
@ -43,16 +44,18 @@ Usage
|
|||
- no carriage returns (use unix newlines) - D004
|
||||
|
||||
positional arguments:
|
||||
path path to scan for *.rst, *.txt files (default:
|
||||
os.getcwd())
|
||||
path path to scan for doc files (default: os.getcwd())
|
||||
|
||||
optional arguments:
|
||||
-h, --help show this help message and exit
|
||||
--config path user config file location (default: doc8.ini, tox.ini,
|
||||
pep8.ini, setup.cfg)
|
||||
--allow-long-titles allow long section titles (default: False)
|
||||
--ignore code ignore the given errors code/codes
|
||||
-h, --help show this help message and exit
|
||||
--config path user config file location (default: doc8.ini, tox.ini,
|
||||
pep8.ini, setup.cfg)
|
||||
--allow-long-titles allow long section titles (default: False)
|
||||
--ignore code ignore the given errors code/codes
|
||||
--max-line-length int
|
||||
maximum allowed line length (default: 79)
|
||||
maximum allowed line length (default: 79)
|
||||
-e extension, --extension extension
|
||||
check file extensions of the given type (default:
|
||||
.rst, .txt)
|
||||
|
||||
.. _rst: http://docutils.sourceforge.net/docs/ref/rst/introduction.html
|
||||
|
|
Loading…
Reference in New Issue