js domain: Remove extra parentheses from function arguments and errors

Author: SilverRainZ

CHANGES.rst

@@ -20,6 +20,8 @@ Features added
   ``linkcheck_allowed_redirects = {}``.
   Patch by Adam Turner.
 * #13497: Support C domain objects in the table of contents.
+* #13217: Remove extra parentheses from :rst:dir:`js:function` arguments and errors.
+  Patch by Shengyu Zhang.
 
 Bugs fixed
 ----------

doc/conf.py

@@ -181,9 +181,9 @@
         'template<typename TOuter> template<typename TInner> Wrapper::Outer<TOuter>::Inner',
     ),
     ('cpp:identifier', 'MyContainer'),
-    ('js:func', 'SomeError'),
-    ('js:func', 'number'),
-    ('js:func', 'string'),
+    ('js:class', 'SomeError'),
+    ('js:class', 'number'),
+    ('js:class', 'string'),
     ('py:attr', 'srcline'),
     ('py:class', '_AutodocProcessDocstringListener'),
     ('py:class', '_ConfigRebuild'),  # sphinx.application.Sphinx.add_config_value

sphinx/domains/javascript.py

@@ -273,13 +273,13 @@ class JSCallable(JSObject):
             'arguments',
             label=_('Arguments'),
             names=('argument', 'arg', 'parameter', 'param'),
-            typerolename='func',
+            typerolename='class',
             typenames=('paramtype', 'type'),
         ),
         GroupedField(
             'errors',
             label=_('Throws'),
-            rolename='func',
+            rolename='class',
             names=('throws',),
             can_collapse=True,
         ),
@@ -431,7 +431,7 @@ class JavaScriptDomain(Domain):
     roles = {
         'func': JSXRefRole(fix_parens=True),
         'meth': JSXRefRole(fix_parens=True),
-        'class': JSXRefRole(fix_parens=True),
+        'class': JSXRefRole(),
         'data': JSXRefRole(),
         'attr': JSXRefRole(),
         'mod': JSXRefRole(),

tests/test_domains/test_domain_js.py

@@ -892,3 +892,17 @@ def test_domain_js_javascript_trailing_comma_in_multi_line_signatures_in_text(ap
         expected_f,
     )
     assert expected_parameter_list_foo in content
+
+
+# See: https://github.com/sphinx-doc/sphinx/issues/13217
+@pytest.mark.sphinx('html', testroot='_blank')
+def test_js_function_parentheses_in_arguments_and_errors(app):
+    text = """.. js:function:: $.getJSON(herf[, error])
+
+         :param string arg:
+         :throws err:"""
+    doctree = restructuredtext.parse(app, text)
+    refnodes = list(doctree.findall(addnodes.pending_xref))
+    assert len(refnodes) == 2
+    assert_node(refnodes[0], [addnodes.pending_xref, nodes.literal, 'string'])
+    assert_node(refnodes[1], [addnodes.pending_xref, nodes.literal, 'err'])