Display 'show_default' string even when 'default=None'

Fixes: #93
click-contrib · Feb 2, 2022 · 7b17062 · 7b17062
1 parent b9ce52d
commit 7b17062
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 14 deletions.
diff --git a/sphinx_click/ext.py b/sphinx_click/ext.py
@@ -73,21 +73,20 @@ def _write_opts(opts):
 
     extras = []
 
-    if opt.default is not None and opt.show_default:
-        if isinstance(opt.show_default, str):
-            # Starting from Click 7.0 this can be a string as well. This is
-            # mostly useful when the default is not a constant and
-            # documentation thus needs a manually written string.
-            extras.append(':default: %s' % opt.show_default)
-        else:
-            extras.append(
-                ':default: %s'
-                % (
-                    ', '.join(str(d) for d in opt.default)
-                    if isinstance(opt.default, (list, tuple))
-                    else opt.default,
-                )
+    if isinstance(opt.show_default, str):
+        # Starting from Click 7.0 show_default can be a string. This is
+        # mostly useful when the default is not a constant and
+        # documentation thus needs a manually written string.
+        extras.append(':default: %s' % opt.show_default)
+    elif opt.default is not None and opt.show_default:
+        extras.append(
+            ':default: %s'
+            % (
+                ', '.join(str(d) for d in opt.default)
+                if isinstance(opt.default, (list, tuple))
+                else opt.default,
             )
+        )
 
     if isinstance(opt.type, click.Choice):
         extras.append(':options: %s' % ' | '.join(str(x) for x in opt.type.choices))

diff --git a/tests/test_formatter.py b/tests/test_formatter.py
@@ -177,6 +177,10 @@ def test_defaults(self):
             multiple=True,
             show_default=True,
         )
+        @click.option(
+            '--only-show-default',
+            show_default="Some default computed at runtime!",
+        )
         def foobar(bar):
             """A sample command."""
             pass
@@ -207,6 +211,10 @@ def foobar(bar):
         .. option:: --group <group>
 
             :default: ('foo', 'bar')
+
+        .. option:: --only-show-default <only_show_default>
+
+            :default: Some default computed at runtime!
         """
             ).lstrip(),
             '\n'.join(output),