Skip to content

Remove unnecessary :func: parentheses #123492

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.

Sign up for GitHub

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

Jump to bottom
Closed
3 tasks done
mattwang44 opened this issue Aug 30, 2024 · 1 comment
Closed
3 tasks done

Remove unnecessary :func: parentheses #123492

mattwang44 opened this issue Aug 30, 2024 · 1 comment
Labels
docs Documentation in the Doc dir

Comments

@mattwang44
Copy link
Contributor

mattwang44 commented Aug 30, 2024 •
edited
Loading

Documentation

The func role's parentheses are unnecessary as Sphinx will add them to the rendered output.

.. bad
:func:`!locale.resetlocale()`

.. good
:func:`!locale.resetlocale`

We're introducing a new rule to the sphinx-lint (issue & PR) and, since sphinx-lint utilizes CPython Docs in the CI, we'd like to also fix the issue.

TODO:

  • fix on main branch
  • backport to 3.12
  • backport to 3.13

Linked PRs
@mattwang44 mattwang44 added the docs Documentation in the Doc dir label Aug 30, 2024
@bedevere-app bedevere-app bot mentioned this issue Aug 30, 2024
Merged
hugovk pushed a commit that referenced this issue Aug 30, 2024
@mattwang44
gh-123492: Remove unnecessary :func: parentheses (#123493)
103a047
mattwang44 added a commit to mattwang44/cpython that referenced this issue Aug 30, 2024
@mattwang44
[3.12] pythongh-123492: remove unnecessary parentheses in func role f…
9496811 
…rom `Doc`
mattwang44 added a commit to mattwang44/cpython that referenced this issue Aug 30, 2024
@mattwang44
[3.12] pythongh-123492: Remove unnecessary :func: parentheses (pyth…
d04de79 
…ongh-123493)
This was referenced Aug 30, 2024
Merged
Merged
hugovk pushed a commit that referenced this issue Aug 30, 2024
@mattwang44
[3.12] gh-123492: Remove unnecessary :func: parentheses (gh-123493) (…
d5abd02 
…#123512)
hugovk pushed a commit that referenced this issue Aug 30, 2024
@mattwang44
[3.13] gh-123492: Remove unnecessary :func: parentheses (gh-123493) (…
9f5f2b7 
…#123513)
@hugovk
Copy link
Member

hugovk commented Aug 30, 2024

Thanks!

@hugovk hugovk closed this as completed Aug 30, 2024
@mattwang44 mattwang44 mentioned this issue Aug 30, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs Documentation in the Doc dir
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@hugovk @mattwang44