-
-
Notifications
You must be signed in to change notification settings - Fork 2.2k
Parameter types in the JavaScript domain have erroneous brackets #13217
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Comments
EDIT: ok it's not that. But looking at the HTML we have: <code class="xref js js-func docutils literal notranslate"><span class="pre">string()</span></code> so EDIT 2: Found a fix. |
The issue is with doc_field_types = [
TypedField(
'arguments',
label=_('Arguments'),
names=('argument', 'arg', 'parameter', 'param'),
typerolename='func',
typenames=('paramtype', 'type'),
),
GroupedField(
'errors',
label=_('Throws'),
rolename='func',
names=('throws',),
can_collapse=True,
),
... The role is |
@picnixz The missing reference warning about So I think changing the |
Uh oh!
There was an error while loading. Please reload this page.
Reported in https://github.com/orgs/sphinx-doc/discussions/13216 by @resnickj
Originally posted by resnickj January 7, 2025
This can be seen right on the Sphinx documentation page for the JavaScript domain: https://www.sphinx-doc.org/en/master/usage/domains/javascript.html
I'm working on a particular set of docs which were last built with Sphinx 3.5, and it did not output parentheses after parameter types. Was this change made intentionally? (I'm not sure why it would ever make sense to have parentheses after parameter type names.) Is there a way to revert to the old behaviour?
Thanks!
The text was updated successfully, but these errors were encountered: