Browse Source

Lowercase the help messages

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
Joshua Harlow 4 years ago
parent
commit
062bf244b6
2 changed files with 25 additions and 25 deletions
  1. 12
    12
      README.rst
  2. 13
    13
      doc8/main.py

+ 12
- 12
README.rst View File

@@ -52,29 +52,29 @@ Command line usage
52 52
 
53 53
     optional arguments:
54 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 56
                             pep8.ini, setup.cfg).
57
-      --allow-long-titles   Allow long section titles (default: False).
58
-      --ignore code         Ignore the given error code(s).
59
-      --no-sphinx           Do not ignore sphinx specific false positives.
60
-      --ignore-path path    Ignore the given directory or file (globs are
57
+      --allow-long-titles   allow long section titles (default: false).
58
+      --ignore code         ignore the given error code(s).
59
+      --no-sphinx           do not ignore sphinx specific false positives.
60
+      --ignore-path path    ignore the given directory or file (globs are
61 61
                             supported).
62 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 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 66
                             without a file extension.
67 67
       --file-encoding encoding
68
-                            Override encoding to use when attempting to determine
68
+                            override encoding to use when attempting to determine
69 69
                             an input files text encoding (providing this avoids
70 70
                             using `chardet` to automatically detect encoding/s)
71 71
       --max-line-length int
72
-                            Maximum allowed line length (default: 79).
72
+                            maximum allowed line length (default: 79).
73 73
       -e extension, --extension extension
74
-                            Check file extensions of the given type (default:
74
+                            check file extensions of the given type (default:
75 75
                             .rst, .txt).
76
-      -v, --verbose         Run in verbose mode.
77
-      --version             Show the version and exit.
76
+      -v, --verbose         run in verbose mode.
77
+      --version             show the version and exit.
78 78
 
79 79
 Ini file usage
80 80
 **************

+ 13
- 13
doc8/main.py View File

@@ -280,36 +280,36 @@ def main():
280 280
         formatter_class=argparse.RawDescriptionHelpFormatter)
281 281
     default_configs = ", ".join(CONFIG_FILENAMES)
282 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 284
                               " (default: current directory)."),
285 285
                         default=[os.getcwd()])
286 286
     parser.add_argument("--config", metavar='path', action="append",
287
-                        help="User config file location"
287
+                        help="user config file location"
288 288
                              " (default: %s)." % default_configs,
289 289
                         default=[])
290 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 292
                         default=False)
293 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 295
                         type=split_set_type,
296 296
                         default=[])
297 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 299
                         default=True, dest='sphinx')
300 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 302
                              " are supported).", metavar='path')
303 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 305
                              " provided file.", metavar='path')
306 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 308
                              " found without a file extension.",
309 309
                         default='', dest='default_extension',
310 310
                         metavar='extension')
311 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 313
                              " to determine an input files text encoding "
314 314
                              "(providing this avoids using `chardet` to"
315 315
                              " automatically detect encoding/s)",
@@ -317,18 +317,18 @@ def main():
317 317
                         metavar='encoding')
318 318
     parser.add_argument("--max-line-length", action="store", metavar="int",
319 319
                         type=int,
320
-                        help="Maximum allowed line"
320
+                        help="maximum allowed line"
321 321
                              " length (default: %s)." % MAX_LINE_LENGTH,
322 322
                         default=MAX_LINE_LENGTH)
323 323
     parser.add_argument("-e", "--extension", action="append",
324 324
                         metavar="extension",
325
-                        help="Check file extensions of the given type"
325
+                        help="check file extensions of the given type"
326 326
                              " (default: %s)." % ", ".join(FILE_PATTERNS),
327 327
                         default=list(FILE_PATTERNS))
328 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 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 332
     args = vars(parser.parse_args())
333 333
     if args.get('version'):
334 334
         print(version.version_string())

Loading…
Cancel
Save