Hammer on that run_tests.py thing again.
[python_utils.git] / argparse_utils.py
index 045d882a2b6c4b18f4a27fd0267a65dd2b4444e4..f73a8936d3eb268b96ea387a543608d24d0ceb51 100644 (file)
@@ -1,5 +1,7 @@
 #!/usr/bin/python3
 
+# © Copyright 2021-2022, Scott Gasch
+
 """Helpers for commandline argument parsing."""
 
 import argparse
@@ -17,7 +19,7 @@ logger = logging.getLogger(__name__)
 
 
 class ActionNoYes(argparse.Action):
-    """An argparse Action that allows for commandline arguments like this:
+    """An argparse Action that allows for commandline arguments like this::
 
         cfg.add_argument(
             '--enable_the_thing',
@@ -26,12 +28,15 @@ class ActionNoYes(argparse.Action):
             help='Should we enable the thing?'
         )
 
-    This creates cmdline arguments:
+    This creates the following cmdline arguments::
 
         --enable_the_thing
         --no_enable_the_thing
 
+    These arguments can be used to indicate the inclusion or exclusion of
+    binary exclusive behaviors.
     """
+
     def __init__(self, option_strings, dest, default=None, required=False, help=None):
         if default is None:
             msg = 'You must provide a default with Yes/No action'