Skip to content

Warn for unnecessary :func: parentheses #114

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

Closed
hugovk opened this issue Aug 24, 2024 · 0 comments · Fixed by #115
Closed

Warn for unnecessary :func: parentheses #114

hugovk opened this issue Aug 24, 2024 · 0 comments · Fixed by #115
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed

Comments

@hugovk
Copy link
Collaborator

hugovk commented Aug 24, 2024

Sometimes authors add parentheses like this:

:func:`!locale.resetlocale()`

But they're not needed, because Sphinx will add them anyway to the rendered output.

Sphinx Lint could warn so authors instead use:

:func:`!locale.resetlocale`

Re: https://github.com/python/cpython/pull/123132/files#r1721239362

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant