fix: move sanitization back inside render_annotations

Author: machow

quartodoc/renderers/md_renderer.py

@@ -114,7 +114,7 @@ def render_annotation(self, el: str) -> str:
         el:
             An object representing a type annotation.
         """
-        return el
+        return sanitize(el)
 
     @dispatch
     def render_annotation(self, el: None) -> str:
@@ -125,9 +125,9 @@ def render_annotation(self, el: expr.Name) -> str:
         # TODO: maybe there is a way to get tabulate to handle this?
         # unescaped pipes screw up table formatting
         if self.render_interlinks:
-            return f"[{el.source}](`{el.full}`)"
+            return f"[{sanitize(el.source)}](`{el.full}`)"
 
-        return el.source
+        return sanitize(el.source)
 
     @dispatch
     def render_annotation(self, el: expr.Expression) -> str:
@@ -415,17 +415,19 @@ def render(self, el: dc.Parameter):
             glob = ""
 
         annotation = self.render_annotation(el.annotation)
+        name = sanitize(el.name)
+
         if self.show_signature_annotations:
             if annotation and has_default:
-                res = f"{glob}{el.name}: {annotation} = {el.default}"
+                res = f"{glob}{name}: {annotation} = {el.default}"
             elif annotation:
-                res = f"{glob}{el.name}: {annotation}"
+                res = f"{glob}{name}: {annotation}"
         elif has_default:
-            res = f"{glob}{el.name}={el.default}"
+            res = f"{glob}{name}={el.default}"
         else:
-            res = f"{glob}{el.name}"
+            res = f"{glob}{name}"
 
-        return sanitize(res)
+        return res
 
     # docstring parts -------------------------------------------------------------
 
@@ -471,7 +473,7 @@ def render(self, el: ds.DocstringSectionAttributes):
     def render(self, el: ds.DocstringAttribute):
         row = [
             sanitize(el.name),
-            sanitize(self.render_annotation(el.annotation)),
+            self.render_annotation(el.annotation),
             sanitize(el.description or "", allow_markdown=True),
         ]
         return row

quartodoc/tests/__snapshots__/test_renderers.ambr

@@ -3,7 +3,13 @@
   '''
   # quartodoc.tests.example_signature.a_complex_signature { #quartodoc.tests.example_signature.a_complex_signature }
 
-  `tests.example_signature.a_complex_signature(x)`
+  `tests.example_signature.a_complex_signature(x: [list](`list`)\[[C](`quartodoc.tests.example_signature.C`) \| [int](`int`) \| None\])`
+  
+  ## Parameters
+  
+  | Name   | Type                                                                                 | Description     | Default    |
+  |--------|--------------------------------------------------------------------------------------|-----------------|------------|
+  | `x`    | [list](`list`)\[[C](`quartodoc.tests.example_signature.C`) \| [int](`int`) \| None\] | The x parameter | _required_ |
   '''
 # ---
 # name: test_render_doc_class[embedded]

quartodoc/tests/example_signature.py

@@ -29,4 +29,9 @@ class C:
 
 
 def a_complex_signature(x: "list[C | int | None]"):
-    ...
+    """
+    Parameters
+    ----------
+    x:
+        The x parameter
+    """

quartodoc/tests/test_renderers.py

@@ -113,7 +113,7 @@ def test_render_doc_module(snapshot, renderer, children):
 
 
 def test_render_annotations_complex(snapshot):
-    renderer = MdRenderer(render_interlinks=True)
+    renderer = MdRenderer(render_interlinks=True, show_signature_annotations=True)
     bp = blueprint(Auto(name="quartodoc.tests.example_signature.a_complex_signature"))
     res = renderer.render(bp)