Skip to content

Commit dc8f12d

Browse files
committed
fix!: do not show self in signatures
1 parent 8e03839 commit dc8f12d

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

quartodoc/renderers/md_renderer.py

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,14 @@ def _fetch_object_dispname(self, el: "dc.Alias | dc.Object"):
9999
return el.canonical_path
100100

101101
raise ValueError(f"Unsupported display_name: `{self.display_name}`")
102+
103+
def _fetch_method_parameters(self, el: dc.Function):
104+
# adapted from mkdocstrings-python jinja tempalate
105+
if el.parent and el.parent.is_class and len(el.parameters) > 0:
106+
if el.parameters[0].name in {"self", "cls"}:
107+
return dc.Parameters(*list(el.parameters)[1:])
108+
109+
return el.parameters
102110

103111
def _render_table(self, rows, headers):
104112
table = tabulate(rows, headers=headers, tablefmt="github")
@@ -162,7 +170,7 @@ def signature(
162170
self, el: Union[dc.Class, dc.Function], source: Optional[dc.Alias] = None
163171
):
164172
name = self._fetch_object_dispname(source or el)
165-
pars = self.render(el.parameters)
173+
pars = self.render(self._fetch_method_parameters(el))
166174

167175
return f"`{name}({pars})`"
168176

0 commit comments

Comments
 (0)