Skip to content

Commit af7191a

Browse files
authored
Merge pull request #181 from machow/refactor-render-table
refactor: _render_table method to conslidate code
2 parents c3a21e0 + 6e77eb8 commit af7191a

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

quartodoc/renderers/md_renderer.py

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,11 @@ def _fetch_object_dispname(self, el: "dc.Alias | dc.Object"):
101101
return el.canonical_path
102102

103103
raise ValueError(f"Unsupported display_name: `{self.display_name}`")
104+
105+
def _render_table(self, rows, headers):
106+
table = tabulate(rows, headers=headers, tablefmt="github")
107+
108+
return table
104109

105110
def render_annotation(self, el: "str | expr.Name | expr.Expression | None"):
106111
"""Special hook for rendering a type annotation.
@@ -411,7 +416,7 @@ def render(self, el: ds.DocstringSectionParameters):
411416
rows = list(map(self.render, el.value))
412417
header = ["Name", "Type", "Description", "Default"]
413418

414-
return tabulate(rows, header, tablefmt="github")
419+
return self._render_table(rows, header)
415420

416421
@dispatch
417422
def render(self, el: ds.DocstringParameter) -> Tuple[str]:
@@ -429,7 +434,7 @@ def render(self, el: ds.DocstringSectionAttributes):
429434
header = ["Name", "Type", "Description"]
430435
rows = list(map(self.render, el.value))
431436

432-
return tabulate(rows, header, tablefmt="github")
437+
return self._render_table(rows, header)
433438

434439
@dispatch
435440
def render(self, el: ds.DocstringAttribute):
@@ -485,7 +490,7 @@ def render(self, el: Union[ds.DocstringSectionReturns, ds.DocstringSectionRaises
485490
rows = list(map(self.render, el.value))
486491
header = ["Type", "Description"]
487492

488-
return tabulate(rows, header, tablefmt="github")
493+
return self._render_table(rows, header)
489494

490495
@dispatch
491496
def render(self, el: Union[ds.DocstringReturn, ds.DocstringRaise]):

0 commit comments

Comments
 (0)