Hide default values for boolean flags

brentyi · Nov 14, 2021 · 5c6b610 · 5c6b610
1 parent 3c438da
commit 5c6b610
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 1 deletion.
diff --git a/dcargs/_arguments.py b/dcargs/_arguments.py
@@ -193,6 +193,14 @@ def _bool_flags(arg: ArgumentDefinition) -> _ArgumentTransformOutput:
     if arg.type != bool:
         return arg, None
 
+    # Populate helptext for boolean flags => don't show default value, which can be
+    # confusing.
+    helptext = (_docstrings.get_field_docstring(arg.parent_class, arg.field.name),)
+    arg = dataclasses.replace(
+        arg,
+        help=helptext if helptext is not None else "",
+    )
+
     if arg.default is None:
         return (
             dataclasses.replace(

diff --git a/setup.py b/setup.py
@@ -5,7 +5,7 @@
 
 setup(
     name="dcargs",
-    version="0.0.6",
+    version="0.0.7",
     description="Portable, reusable, strongly typed CLIs from dataclass definitions",
     long_description=long_description,
     long_description_content_type="text/markdown",