Handle iterables of iterables as default values

Signed-off-by: Stephen Finucane <stephen@that.guru> Closes: #91
click-contrib · Jan 27, 2022 · 6aeee37 · 6aeee37
1 parent d53cd26
commit 6aeee37
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 1 deletion.
diff --git a/sphinx_click/ext.py b/sphinx_click/ext.py
@@ -83,7 +83,7 @@ def _write_opts(opts):
             extras.append(
                 ':default: %s'
                 % (
-                    ', '.join('%s' % d for d in opt.default)
+                    ', '.join(str(d) for d in opt.default)
                     if isinstance(opt.default, (list, tuple))
                     else opt.default,
                 )

diff --git a/tests/test_formatter.py b/tests/test_formatter.py
@@ -169,6 +169,14 @@ def test_defaults(self):
             default=lambda: None,
             show_default='Something computed at runtime',
         )
+        @click.option(
+            '--group',
+            default=[('foo', 'bar')],
+            nargs=2,
+            type=click.Tuple([str, str]),
+            multiple=True,
+            show_default=True,
+        )
         def foobar(bar):
             """A sample command."""
             pass
@@ -195,6 +203,10 @@ def foobar(bar):
         .. option:: --param <param>
 
             :default: Something computed at runtime
+
+        .. option:: --group <group>
+
+            :default: ('foo', 'bar')
         """
             ).lstrip(),
             '\n'.join(output),