Skip to content

Commit a50cb24

Browse files
committed
Pass multiline as desc_parameterlist attribute
1 parent 61481d1 commit a50cb24

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
@@ -243,10 +243,6 @@ class desc_parameterlist(nodes.Part, nodes.Inline, nodes.FixedTextElement):
243243
"""Node for a general parameter list."""
244244
child_text_separator = ', '
245245

246-
def __init__(self, *args: Any, multiline: bool = False, **kwargs: Any) -> None:
247-
super().__init__(*args, **kwargs)
248-
self.multiline = multiline
249-
250246
def astext(self):
251247
return f'({super().astext()})'
252248

sphinx/domains/c.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -721,7 +721,8 @@ def describe_signature(self, signode: TextElement, mode: str,
721721
multiline = self.multiline
722722
# only use the desc_parameterlist for the outer list, not for inner lists
723723
if mode == 'lastIsName':
724-
paramlist = addnodes.desc_parameterlist(multiline=multiline)
724+
paramlist = addnodes.desc_parameterlist()
725+
paramlist['is_multiline'] = multiline
725726
for arg in self.args:
726727
param_node = addnodes.desc_content() if multiline else paramlist
727728
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
@@ -228,7 +228,8 @@ def _parse_arglist(
228228
arglist: str, env: Optional[BuildEnvironment] = None, multiline=False
229229
) -> addnodes.desc_parameterlist:
230230
"""Parse a list of arguments using AST parser"""
231-
params = addnodes.desc_parameterlist(multiline=multiline)
231+
params = addnodes.desc_parameterlist()
232+
params['is_multiline'] = multiline
232233
sig = signature_from_str('(%s)' % arglist)
233234
last_kind = None
234235
for param in sig.parameters.values():

sphinx/writers/html5.py

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

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

0 commit comments

Comments
 (0)