🐛📝: Consistent CLI documentation.

Signed-off-by: rjdbcm <[email protected]>

ozi/__main__.py

@@ -31,19 +31,19 @@
   | status
   | topic
 
-LICENSE_EXPR:
+LICENSE_EXPR: :term:`SPDX license expression`
   | See https://spdx.github.io/spdx-spec/v2-draft/SPDX-license-expressions/
 
 project authoring console application:
-  | ozi-new -h         show help for the ozi-new command.
+  | ``ozi-new -h``         show help for the ozi-new command.
 
 project maintainence console application:
-  | ozi-fix -h         show help for the ozi-fix command.
+  | ``ozi-fix -h``         show help for the ozi-fix command.
 
 continuous integration checkpoints:
-  | tox -e lint        run formatting, linting, and typechecking.
-  | tox -e test        run testing and coverage.
-  | tox -e dist        run distribution and packaging.
+  | ``tox -e lint``        run formatting, linting, and typechecking.
+  | ``tox -e test``        run testing and coverage.
+  | ``tox -e dist``        run distribution and packaging.
 """  # pragma: no cover
 
 parser = argparse.ArgumentParser(

ozi/fix/parser.py

@@ -48,13 +48,13 @@
     '--strict',
     default=False,
     action=BooleanOptionalAction,
-    help='strict mode raises warnings to errors default: ``--no-strict``',
+    help='strict mode raises warnings to errors, default: no',
 )
 missing_output.add_argument(
     '--pretty',
     default=False,
     action=BooleanOptionalAction,
-    help='pretty mode outputs indented json, default: ``--no-pretty``',
+    help='pretty mode outputs indented json, default: no',
 )
 missing_parser.add_argument(
     'target',
@@ -117,13 +117,13 @@
     '--strict',
     default=False,
     action=BooleanOptionalAction,
-    help='strict mode raises warnings to errors.',
+    help='strict mode raises warnings to errors, default: no',
 )
 source_output.add_argument(
-    '-p',
     '--pretty',
-    action='store_true',
-    help='pretty print JSON output',
+    default=False,
+    action=BooleanOptionalAction,
+    help='pretty mode outputs indented json, default: no',
 )
 test_parser.add_argument(
     '-a',
@@ -163,13 +163,13 @@
     '--strict',
     default=False,
     action=BooleanOptionalAction,
-    help='strict mode raises warnings to errors.',
+    help='strict mode raises warnings to errors, default: no',
 )
 test_output.add_argument(
-    '-p',
     '--pretty',
-    action='store_true',
-    help='pretty print JSON output',
+    default=False,
+    action=BooleanOptionalAction,
+    help='pretty mode outputs indented json, default: no',
 )
 tools = parser.add_mutually_exclusive_group()  # pragma: no cover
 tools.add_argument(  # pragma: no cover

ozi/new/parser.py

@@ -117,7 +117,7 @@
     '--intended-audience',
     metavar='AUDIENCE_NAMES',
     type=str,
-    help='Classifier: Intended Audience (Multiple Use)(default: ["Other Audience"])',
+    help='Classifier: Intended Audience (Multiple Use), default: ["Other Audience"]',
     default=METADATA.spec.python.pkg.info.classifiers.intended_audience,
     nargs='?',
     action=CloseMatch,
@@ -128,14 +128,14 @@
     choices=frozenset(('Typed', 'Stubs Only')),
     nargs='?',
     metavar='PY_TYPED_OR_STUBS',
-    help='Classifier: Typing (Multiple Use)(default: [Typed])',
+    help='Classifier: Typing (Multiple Use), default: ["Typed"]',
     default=METADATA.spec.python.pkg.info.classifiers.typing,
 )
 defaults.add_argument(
     '--environment',
     metavar='ENVIRONMENT_NAMES',
     default=METADATA.spec.python.pkg.info.classifiers.environment,
-    help='Classifier: Environment (Multiple Use)(default: ["Other Environment"])',
+    help='Classifier: Environment (Multiple Use), default: ["Other Environment"]',
     action=CloseMatch,
     nargs='?',
     type=str,
@@ -145,7 +145,7 @@
     default='LICENSE.txt',
     metavar='LICENSE_FILENAME',
     choices=frozenset(('LICENSE.txt',)),
-    help='Classifier: License File (Single Use)(default: LICENSE.txt)',
+    help='Classifier: License File (Single Use), default: "LICENSE.txt"',
     type=str,
 )
 optional.add_argument(
@@ -192,7 +192,7 @@
     '--natural-language',
     metavar='LANGUAGE_NAMES',
     default=['English'],
-    help='Classifier: Natural Language (Multiple Use)(default: [English])',
+    help='Classifier: Natural Language (Multiple Use), default: ["English"]',
     action=CloseMatch,
     type=str,
     nargs='?',
@@ -211,7 +211,7 @@
     '--development-status',
     action=CloseMatch,
     default=METADATA.spec.python.pkg.info.classifiers.development_status,
-    help='Classifier: Development Status (Single Use)(default: "1 - Planning")',
+    help='Classifier: Development Status (Single Use), default: "1 - Planning"',
     type=str,
 )
 defaults.add_argument(
@@ -238,23 +238,23 @@
     '--verify-email',
     default=False,
     action=argparse.BooleanOptionalAction,
-    help='verify email domain deliverability(default: ``--no-verify-email``)',
+    help='verify email domain deliverability, default: no',
 )
 ozi_defaults.add_argument(
     '--enable-cython',
     default=False,
     action=argparse.BooleanOptionalAction,
-    help='build extension module with Cython(default: ``--no-enable-cython``)',
+    help='build extension module with Cython, default: no',
 )
 ozi_defaults.add_argument(
     '--strict',
     default=False,
     action=argparse.BooleanOptionalAction,
-    help='strict mode raises warnings to errors(default: ``--strict``)',
+    help='strict mode raises warnings to errors, default',
 )
 ozi_defaults.add_argument(
     '--allow-file',
-    help='Add a file to the allow list for new project target folder(default: [templates,.git])',
+    help='Add a file to the allow list for new project target folder, default: [templates,.git]',
     action='append',
     type=str,
     nargs='?',