Merge pull request #381 from machow/fix-multiline-signature

Fix: add trailing commas to multiline signature
machow · Nov 8, 2024 · ee4fa3c · ee4fa3c
2 parents 5fa28ec + 5274a16
commit ee4fa3c
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 7 deletions.
diff --git a/quartodoc/renderers/md_renderer.py b/quartodoc/renderers/md_renderer.py
@@ -268,7 +268,7 @@ def signature(
 
         flat_sig = f"{name}({', '.join(pars)})"
         if len(flat_sig) > 80:
-            indented = [" " * 4 + par for par in pars]
+            indented = [" " * 4 + par + "," for par in pars]
             sig = "\n".join([f"{name}(", *indented, ")"])
         else:
             sig = flat_sig

diff --git a/quartodoc/tests/__snapshots__/test_renderers.ambr b/quartodoc/tests/__snapshots__/test_renderers.ambr
@@ -5,9 +5,9 @@
 
   ```python
   tests.example_signature.a_complex_signature(
-      x: list[C | int | None]
-      y: pathlib.Pathlib
-      z
+      x: list[C | int | None],
+      y: pathlib.Pathlib,
+      z,
   )
   ```
 
@@ -26,9 +26,9 @@
 
   ```python
   tests.example_signature.a_complex_signature(
-      x: list[C | int | None]
-      y: pathlib.Pathlib
-      z
+      x: list[C | int | None],
+      y: pathlib.Pathlib,
+      z,
   )
   ```