Skip to content
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

DOC: Remove unnecessary parentheses in :func: & :meth: role #59663

Merged
merged 1 commit into from
Aug 30, 2024
Merged

DOC: Remove unnecessary parentheses in :func: & :meth: role #59663

merged 1 commit into from
Aug 30, 2024

Conversation

mattwang44
Copy link
Contributor

@mattwang44 mattwang44 commented Aug 30, 2024


The func & meth 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.

@mattwang44 mattwang44 changed the title DOC: Remove unnecessary parentheses in func role DOC: Remove unnecessary parentheses in :func: role Aug 30, 2024
@mattwang44 mattwang44 changed the title DOC: Remove unnecessary parentheses in :func: role DOC: Remove unnecessary parentheses in :func: & :meth: role Aug 30, 2024
@mroeschke mroeschke added the Docs label Aug 30, 2024
@mroeschke mroeschke added this to the 3.0 milestone Aug 30, 2024
@mroeschke mroeschke merged commit 45cafb5 into pandas-dev:main Aug 30, 2024
18 checks passed
@mroeschke
Copy link
Member

Thanks @mattwang44 great to see a new sphinx-lint rule for this in the future

@mattwang44 mattwang44 deleted the fix-unnecessary-parentheses-in-rst-content branch August 30, 2024 18:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

DOC: Remove unnecessary :func: & :meth: parentheses
2 participants