Simplify desc_parameterlist into single class

Author: TLouf

sphinx/addnodes.py

@@ -243,14 +243,9 @@ class desc_parameterlist(nodes.Part, nodes.Inline, nodes.FixedTextElement):
     """Node for a general parameter list."""
     child_text_separator = ', '
 
-    def astext(self):
-        return f'({super().astext()})'
-
-
-class desc_multiline_parameterlist(nodes.Part, nodes.Inline, nodes.FixedTextElement):
-    """Node for a multiline parameter list.
-    """
-    child_text_separator = ', '
+    def __init__(self, *args: Any, multiline: bool = False, **kwargs: Any) -> None:
+        super().__init__(*args, **kwargs)
+        self.multiline = multiline
 
     def astext(self):
         return f'({super().astext()})'

sphinx/domains/c.py

@@ -716,7 +716,7 @@ def describe_signature(self, signode: TextElement, mode: str,
         multiline = self.multiline
         # only use the desc_parameterlist for the outer list, not for inner lists
         if mode == 'lastIsName':
-            paramlist = addnodes.desc_multiline_parameterlist() if multiline else addnodes.desc_parameterlist()
+            paramlist = addnodes.desc_parameterlist(multiline=multiline)
             for arg in self.args:
                 param_node = addnodes.desc_content() if multiline else paramlist
                 param = addnodes.desc_parameter('', '', noemph=True)

sphinx/domains/cpp.py

@@ -2133,7 +2133,7 @@ def describe_signature(self, signode: TextElement, mode: str,
         multiline = self.multiline
         # only use the desc_parameterlist for the outer list, not for inner lists
         if mode == 'lastIsName':
-            paramlist = addnodes.desc_multiline_parameterlist() if multiline else addnodes.desc_parameterlist()
+            paramlist = addnodes.desc_parameterlist(multiline=multiline)
             for arg in self.args:
                 param_node = addnodes.desc_content() if multiline else paramlist
                 param = addnodes.desc_parameter('', '', noemph=True)

sphinx/domains/python.py

@@ -228,7 +228,7 @@ def _parse_arglist(
     arglist: str, env: Optional[BuildEnvironment] = None, multiline=False
 ) -> addnodes.desc_parameterlist:
     """Parse a list of arguments using AST parser"""
-    params = addnodes.desc_multiline_parameterlist(arglist) if multiline else addnodes.desc_parameterlist(arglist)
+    params = addnodes.desc_parameterlist(multiline=multiline)
     sig = signature_from_str('(%s)' % arglist)
     last_kind = None
     for param in sig.parameters.values():

sphinx/writers/html5.py

@@ -155,22 +155,12 @@ def visit_desc_parameterlist(self, node: Element) -> None:
         self.required_params_left = sum([isinstance(c, addnodes.desc_parameter)
                                          for c in node.children])
         self.param_separator = node.child_text_separator
+        if node.multiline:
+            self.body.append(self.starttag(node, 'dl'))
 
     def depart_desc_parameterlist(self, node: Element) -> None:
-        self.body.append('<span class="sig-paren">)</span>')
-
-    def visit_desc_multiline_parameterlist(self, node: Element) -> None:
-        self.body.append('<span class="sig-paren">(</span>')
-        self.first_param = 1
-        self.optional_param_level = 0
-        # How many required parameters are left.
-        self.required_params_left = sum([isinstance(c, addnodes.desc_parameter)
-                                         for c in node.children])
-        self.param_separator = node.child_text_separator
-        self.body.append(self.starttag(node, 'dl'))
-
-    def depart_desc_multiline_parameterlist(self, node: Element) -> None:
-        self.body.append('</dl>\n\n')
+        if node.multiline:
+            self.body.append('</dl>\n\n')
         self.body.append('<span class="sig-paren">)</span>')
 
     # If required parameters are still to come, then put the comma after