Skip to content

Remove unnecessary :func: parentheses #123492

@mattwang44

Description

@mattwang44

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    docsDocumentation in the Doc dir

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions