Skip to content

Commit 85ff493

Browse files
committed
Pass multiline as desc_parameterlist attribute
1 parent ec713e9 commit 85ff493

File tree

5 files changed

+8
-9
lines changed

5 files changed

+8
-9
lines changed

sphinx/addnodes.py

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -245,10 +245,6 @@ class desc_parameterlist(nodes.Part, nodes.Inline, nodes.FixedTextElement):
245245
"""Node for a general parameter list."""
246246
child_text_separator = ', '
247247

248-
def __init__(self, *args: Any, multiline: bool = False, **kwargs: Any) -> None:
249-
super().__init__(*args, **kwargs)
250-
self.multiline = multiline
251-
252248
def astext(self):
253249
return f'({super().astext()})'
254250

sphinx/domains/c.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -722,7 +722,8 @@ def describe_signature(self, signode: TextElement, mode: str,
722722
multiline = self.multiline
723723
# only use the desc_parameterlist for the outer list, not for inner lists
724724
if mode == 'lastIsName':
725-
paramlist = addnodes.desc_parameterlist(multiline=multiline)
725+
paramlist = addnodes.desc_parameterlist()
726+
paramlist['is_multiline'] = multiline
726727
for arg in self.args:
727728
param_node = addnodes.desc_content() if multiline else paramlist
728729
param = addnodes.desc_parameter('', '', noemph=True)

sphinx/domains/cpp.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2133,7 +2133,8 @@ def describe_signature(self, signode: TextElement, mode: str,
21332133
multiline = self.multiline
21342134
# only use the desc_parameterlist for the outer list, not for inner lists
21352135
if mode == 'lastIsName':
2136-
paramlist = addnodes.desc_parameterlist(multiline=multiline)
2136+
paramlist = addnodes.desc_parameterlist()
2137+
paramlist['is_multiline'] = multiline
21372138
for arg in self.args:
21382139
param_node = addnodes.desc_content() if multiline else paramlist
21392140
param = addnodes.desc_parameter('', '', noemph=True)

sphinx/domains/python.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -254,7 +254,8 @@ def _parse_arglist(
254254
arglist: str, env: BuildEnvironment | None = None, multiline=False
255255
) -> addnodes.desc_parameterlist:
256256
"""Parse a list of arguments using AST parser"""
257-
params = addnodes.desc_parameterlist(multiline=multiline)
257+
params = addnodes.desc_parameterlist()
258+
params['is_multiline'] = multiline
258259
sig = signature_from_str('(%s)' % arglist)
259260
last_kind = None
260261
for param in sig.parameters.values():

sphinx/writers/html5.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -157,11 +157,11 @@ def visit_desc_parameterlist(self, node: Element) -> None:
157157
self.required_params_left = sum([isinstance(c, addnodes.desc_parameter)
158158
for c in node.children])
159159
self.param_separator = node.child_text_separator
160-
if node.multiline:
160+
if node.get('is_multiline'):
161161
self.body.append(self.starttag(node, 'dl'))
162162

163163
def depart_desc_parameterlist(self, node: Element) -> None:
164-
if node.multiline:
164+
if node.get('is_multiline'):
165165
self.body.append('</dl>\n\n')
166166
self.body.append('<span class="sig-paren">)</span>')
167167

0 commit comments

Comments
 (0)