[render] do not use a dash if there's no description to introduce (#12035)

Co-authored-by: Bénédikt Tran <[email protected]>

Author: nedbat

sphinx/util/docfields.py

@@ -236,7 +236,7 @@ def make_field(
         inliner: Inliner | None = None,
         location: Element | None = None,
     ) -> nodes.field:
-        def handle_item(fieldarg: str, content: str) -> nodes.paragraph:
+        def handle_item(fieldarg: str, content: list[Node]) -> nodes.paragraph:
             par = nodes.paragraph()
             par.extend(self.make_xrefs(self.rolename, domain, fieldarg,
                                        addnodes.literal_strong, env=env))
@@ -254,8 +254,10 @@ def handle_item(fieldarg: str, content: str) -> nodes.paragraph:
                 else:
                     par += fieldtype
                 par += nodes.Text(')')
-            par += nodes.Text(' -- ')
-            par += content
+            has_content = any(c.astext().strip() for c in content)
+            if has_content:
+                par += nodes.Text(' -- ')
+                par += content
             return par
 
         fieldname = nodes.field_name('', self.label)

tests/test_extensions/test_ext_autodoc_configs.py

@@ -969,17 +969,17 @@ def test_autodoc_typehints_description(app):
     assert ('target.typehints.incr(a, b=1)\n'
             '\n'
             '   Parameters:\n'
-            '      * **a** (*int*) --\n'
+            '      * **a** (*int*)\n'
             '\n'
-            '      * **b** (*int*) --\n'
+            '      * **b** (*int*)\n'
             '\n'
             '   Return type:\n'
             '      int\n'
             in context)
     assert ('target.typehints.tuple_args(x)\n'
             '\n'
             '   Parameters:\n'
-            '      **x** (*tuple**[**int**, **int** | **str**]*) --\n'
+            '      **x** (*tuple**[**int**, **int** | **str**]*)\n'
             '\n'
             '   Return type:\n'
             '      tuple[int, int]\n'
@@ -1117,11 +1117,11 @@ def test_autodoc_typehints_description_with_documented_init(app):
         '   Class docstring.\n'
         '\n'
         '   Parameters:\n'
-        '      * **x** (*int*) --\n'
+        '      * **x** (*int*)\n'
         '\n'
-        '      * **args** (*int*) --\n'
+        '      * **args** (*int*)\n'
         '\n'
-        '      * **kwargs** (*int*) --\n'
+        '      * **kwargs** (*int*)\n'
         '\n'
         '   __init__(x, *args, **kwargs)\n'
         '\n'
@@ -1217,17 +1217,17 @@ def test_autodoc_typehints_both(app):
     assert ('target.typehints.incr(a: int, b: int = 1) -> int\n'
             '\n'
             '   Parameters:\n'
-            '      * **a** (*int*) --\n'
+            '      * **a** (*int*)\n'
             '\n'
-            '      * **b** (*int*) --\n'
+            '      * **b** (*int*)\n'
             '\n'
             '   Return type:\n'
             '      int\n'
             in context)
     assert ('target.typehints.tuple_args(x: tuple[int, int | str]) -> tuple[int, int]\n'
             '\n'
             '   Parameters:\n'
-            '      **x** (*tuple**[**int**, **int** | **str**]*) --\n'
+            '      **x** (*tuple**[**int**, **int** | **str**]*)\n'
             '\n'
             '   Return type:\n'
             '      tuple[int, int]\n'
@@ -1401,9 +1401,9 @@ def test_autodoc_typehints_description_and_type_aliases(app):
         '   docstring\n'
         '\n'
         '   Parameters:\n'
-        '      * **x** (*myint*) --\n'
+        '      * **x** (*myint*)\n'
         '\n'
-        '      * **y** (*myint*) --\n'
+        '      * **y** (*myint*)\n'
         '\n'
         '   Return type:\n'
         '      myint\n'