refactor!: move sanitize description to inside ParamRow

Author: machow

quartodoc/renderers/md_renderer.py

@@ -59,7 +59,7 @@ class ParamRow:
     def to_definition_list(self):
         name = self.name
         anno = self.annotation
-        desc = self.description
+        desc = sanitize(self.description, allow_markdown=True)
         default = sanitize(str(self.default))
 
         part_name = (
@@ -100,13 +100,15 @@ def to_definition_list(self):
 
     def to_tuple(self, style: Literal["parameters", "attributes", "returns"]):
         name = self.name
+        description = sanitize(self.description, allow_markdown=True)
+
         if style == "parameters":
             default = "_required_" if self.default is None else escape(self.default)
-            return (name, self.annotation, self.description, default)
+            return (name, self.annotation, description, default)
         elif style == "attributes":
-            return (name, self.annotation, self.description)
+            return (name, self.annotation, description)
         elif style == "returns":
-            return (name, self.annotation, self.description)
+            return (name, self.annotation, description)
 
         raise NotImplementedError(f"Unsupported table style: {style}")
 
@@ -595,8 +597,9 @@ def render(self, el: ds.DocstringSectionParameters):
     @dispatch
     def render(self, el: ds.DocstringParameter) -> ParamRow:
         annotation = self.render_annotation(el.annotation)
-        clean_desc = sanitize(el.description, allow_markdown=True)
-        return ParamRow(el.name, clean_desc, annotation=annotation, default=el.default)
+        return ParamRow(
+            el.name, el.description, annotation=annotation, default=el.default
+        )
 
     # attributes ----
 
@@ -611,7 +614,7 @@ def render(self, el: ds.DocstringSectionAttributes):
     def render(self, el: ds.DocstringAttribute) -> ParamRow:
         return ParamRow(
             el.name,
-            sanitize(el.description or "", allow_markdown=True),
+            el.description or "",
             annotation=self.render_annotation(el.annotation),
         )
 
@@ -680,7 +683,7 @@ def render(self, el: ds.DocstringReturn):
         # similar to DocstringParameter, but no name or default
         return ParamRow(
             el.name,
-            sanitize(el.description, allow_markdown=True),
+            el.description,
             annotation=self.render_annotation(el.annotation),
         )
 
@@ -689,7 +692,7 @@ def render(self, el: ds.DocstringRaise) -> ParamRow:
         # similar to DocstringParameter, but no name or default
         return ParamRow(
             None,
-            sanitize(el.description, allow_markdown=True),
+            el.description,
             annotation=self.render_annotation(el.annotation),
         )