Skip to content

DOC: Remove unnecessary :func: & :meth: parentheses #59662

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
1 task done
mattwang44 opened this issue Aug 30, 2024 · 0 comments · Fixed by #59663
Closed
1 task done

DOC: Remove unnecessary :func: & :meth: parentheses #59662

mattwang44 opened this issue Aug 30, 2024 · 0 comments · Fixed by #59663
Labels
Docs Needs Triage Issue that has not been reviewed by a pandas team member

Comments

@mattwang44
Copy link
Contributor

mattwang44 commented Aug 30, 2024

Pandas version checks

  • I have checked that the issue still exists on the latest versions of the docs on main here

Location of the documentation

use regex pattern :(func|meth):`[^`]+()` to search for the occurrences

Documentation problem

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

.. bad
:func:`read_csv()`

.. good
:func:`read_csv`

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

Suggested fix for documentation

remove unnecessary :func: & :meth: parentheses in reST content

@mattwang44 mattwang44 added Docs Needs Triage Issue that has not been reviewed by a pandas team member labels Aug 30, 2024
@mattwang44 mattwang44 changed the title DOC: Remove unnecessary :func: parentheses DOC: Remove unnecessary :func: & :meth: parentheses Aug 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs Needs Triage Issue that has not been reviewed by a pandas team member
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant