summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJoshua Harlow <harlowja@gmail.com>2015-04-09 08:24:07 -0700
committerJoshua Harlow <harlowja@gmail.com>2015-04-09 08:26:27 -0700
commit062bf244b69e5e3ced3ce78c6821f9008a182cff (patch)
tree96b87368afe0a1fa060465ccfe6109cf111065c1
parent24a3c9642ac5e4a1772773590d0e266e36879f3e (diff)
Lowercase the help messages0.6.0
It seems to be common practice to lowercase these instead of uppercasing the first word so let's just follow that practice. Change-Id: I2c8620257cd9f0566e1d7e1ec88461f18f0bcef4
Notes
Notes (review): Verified+2: Jenkins Code-Review+2: Joshua Harlow <harlowja@yahoo-inc.com> Workflow+1: Joshua Harlow <harlowja@yahoo-inc.com> Submitted-by: Jenkins Submitted-at: Thu, 09 Apr 2015 16:53:47 +0000 Reviewed-on: https://review.openstack.org/172115 Project: stackforge/doc8 Branch: refs/heads/master
-rw-r--r--README.rst24
-rw-r--r--doc8/main.py26
2 files changed, 25 insertions, 25 deletions
diff --git a/README.rst b/README.rst
index 46b8ce7..3ff9e2e 100644
--- a/README.rst
+++ b/README.rst
@@ -52,29 +52,29 @@ Command line usage
52 52
53 optional arguments: 53 optional arguments:
54 -h, --help show this help message and exit 54 -h, --help show this help message and exit
55 --config path User config file location (default: doc8.ini, tox.ini, 55 --config path user config file location (default: doc8.ini, tox.ini,
56 pep8.ini, setup.cfg). 56 pep8.ini, setup.cfg).
57 --allow-long-titles Allow long section titles (default: False). 57 --allow-long-titles allow long section titles (default: false).
58 --ignore code Ignore the given error code(s). 58 --ignore code ignore the given error code(s).
59 --no-sphinx Do not ignore sphinx specific false positives. 59 --no-sphinx do not ignore sphinx specific false positives.
60 --ignore-path path Ignore the given directory or file (globs are 60 --ignore-path path ignore the given directory or file (globs are
61 supported). 61 supported).
62 --ignore-path-errors path 62 --ignore-path-errors path
63 Ignore the given specific errors in the provided file. 63 ignore the given specific errors in the provided file.
64 --default-extension extension 64 --default-extension extension
65 Default file extension to use when a file is found 65 default file extension to use when a file is found
66 without a file extension. 66 without a file extension.
67 --file-encoding encoding 67 --file-encoding encoding
68 Override encoding to use when attempting to determine 68 override encoding to use when attempting to determine
69 an input files text encoding (providing this avoids 69 an input files text encoding (providing this avoids
70 using `chardet` to automatically detect encoding/s) 70 using `chardet` to automatically detect encoding/s)
71 --max-line-length int 71 --max-line-length int
72 Maximum allowed line length (default: 79). 72 maximum allowed line length (default: 79).
73 -e extension, --extension extension 73 -e extension, --extension extension
74 Check file extensions of the given type (default: 74 check file extensions of the given type (default:
75 .rst, .txt). 75 .rst, .txt).
76 -v, --verbose Run in verbose mode. 76 -v, --verbose run in verbose mode.
77 --version Show the version and exit. 77 --version show the version and exit.
78 78
79Ini file usage 79Ini file usage
80************** 80**************
diff --git a/doc8/main.py b/doc8/main.py
index 0196328..4f2d4f5 100644
--- a/doc8/main.py
+++ b/doc8/main.py
@@ -280,36 +280,36 @@ def main():
280 formatter_class=argparse.RawDescriptionHelpFormatter) 280 formatter_class=argparse.RawDescriptionHelpFormatter)
281 default_configs = ", ".join(CONFIG_FILENAMES) 281 default_configs = ", ".join(CONFIG_FILENAMES)
282 parser.add_argument("paths", metavar='path', type=str, nargs='*', 282 parser.add_argument("paths", metavar='path', type=str, nargs='*',
283 help=("Path to scan for doc files" 283 help=("path to scan for doc files"
284 " (default: current directory)."), 284 " (default: current directory)."),
285 default=[os.getcwd()]) 285 default=[os.getcwd()])
286 parser.add_argument("--config", metavar='path', action="append", 286 parser.add_argument("--config", metavar='path', action="append",
287 help="User config file location" 287 help="user config file location"
288 " (default: %s)." % default_configs, 288 " (default: %s)." % default_configs,
289 default=[]) 289 default=[])
290 parser.add_argument("--allow-long-titles", action="store_true", 290 parser.add_argument("--allow-long-titles", action="store_true",
291 help="Allow long section titles (default: False).", 291 help="allow long section titles (default: false).",
292 default=False) 292 default=False)
293 parser.add_argument("--ignore", action="append", metavar="code", 293 parser.add_argument("--ignore", action="append", metavar="code",
294 help="Ignore the given error code(s).", 294 help="ignore the given error code(s).",
295 type=split_set_type, 295 type=split_set_type,
296 default=[]) 296 default=[])
297 parser.add_argument("--no-sphinx", action="store_false", 297 parser.add_argument("--no-sphinx", action="store_false",
298 help="Do not ignore sphinx specific false positives.", 298 help="do not ignore sphinx specific false positives.",
299 default=True, dest='sphinx') 299 default=True, dest='sphinx')
300 parser.add_argument("--ignore-path", action="append", default=[], 300 parser.add_argument("--ignore-path", action="append", default=[],
301 help="Ignore the given directory or file (globs" 301 help="ignore the given directory or file (globs"
302 " are supported).", metavar='path') 302 " are supported).", metavar='path')
303 parser.add_argument("--ignore-path-errors", action="append", default=[], 303 parser.add_argument("--ignore-path-errors", action="append", default=[],
304 help="Ignore the given specific errors in the" 304 help="ignore the given specific errors in the"
305 " provided file.", metavar='path') 305 " provided file.", metavar='path')
306 parser.add_argument("--default-extension", action="store", 306 parser.add_argument("--default-extension", action="store",
307 help="Default file extension to use when a file is" 307 help="default file extension to use when a file is"
308 " found without a file extension.", 308 " found without a file extension.",
309 default='', dest='default_extension', 309 default='', dest='default_extension',
310 metavar='extension') 310 metavar='extension')
311 parser.add_argument("--file-encoding", action="store", 311 parser.add_argument("--file-encoding", action="store",
312 help="Override encoding to use when attempting" 312 help="override encoding to use when attempting"
313 " to determine an input files text encoding " 313 " to determine an input files text encoding "
314 "(providing this avoids using `chardet` to" 314 "(providing this avoids using `chardet` to"
315 " automatically detect encoding/s)", 315 " automatically detect encoding/s)",
@@ -317,18 +317,18 @@ def main():
317 metavar='encoding') 317 metavar='encoding')
318 parser.add_argument("--max-line-length", action="store", metavar="int", 318 parser.add_argument("--max-line-length", action="store", metavar="int",
319 type=int, 319 type=int,
320 help="Maximum allowed line" 320 help="maximum allowed line"
321 " length (default: %s)." % MAX_LINE_LENGTH, 321 " length (default: %s)." % MAX_LINE_LENGTH,
322 default=MAX_LINE_LENGTH) 322 default=MAX_LINE_LENGTH)
323 parser.add_argument("-e", "--extension", action="append", 323 parser.add_argument("-e", "--extension", action="append",
324 metavar="extension", 324 metavar="extension",
325 help="Check file extensions of the given type" 325 help="check file extensions of the given type"
326 " (default: %s)." % ", ".join(FILE_PATTERNS), 326 " (default: %s)." % ", ".join(FILE_PATTERNS),
327 default=list(FILE_PATTERNS)) 327 default=list(FILE_PATTERNS))
328 parser.add_argument("-v", "--verbose", dest="verbose", action='store_true', 328 parser.add_argument("-v", "--verbose", dest="verbose", action='store_true',
329 help="Run in verbose mode.", default=False) 329 help="run in verbose mode.", default=False)
330 parser.add_argument("--version", dest="version", action='store_true', 330 parser.add_argument("--version", dest="version", action='store_true',
331 help="Show the version and exit.", default=False) 331 help="show the version and exit.", default=False)
332 args = vars(parser.parse_args()) 332 args = vars(parser.parse_args())
333 if args.get('version'): 333 if args.get('version'):
334 print(version.version_string()) 334 print(version.version_string())