Skip to content

DOC: Fixes dangling parenthesis in .rst files #61501

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

Merged

Conversation

mattpopovich
Copy link
Contributor

@mattpopovich mattpopovich commented May 26, 2025

  • closes #xxxx (Replace xxxx with the GitHub issue number)
  • Tests added and passed if fixing a bug or adding a new feature
  • All code checks passed.
  • Added type annotations to new arguments/methods/functions.
  • Added an entry in the latest doc/source/whatsnew/vX.X.X.rst file if fixing a bug or adding a new feature.

I initially found a missing closing parenthesis in the documentation, then I decided to write a script to find others. This MR fixes them to the best of my ability.

@mattpopovich mattpopovich requested a review from noatamir as a code owner May 26, 2025 20:42
Copy link
Member

@datapythonista datapythonista left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @mattpopovich, very cool.

If you are interested, it could be cool to have this validation in the CI, so no more unmatched parenthesis are introduced. There are different ways to do this, maybe creating a generic sphinx extension, and release it to pypi would be the cleaner. Also other projects could benefit from this. Or if short, adding the script to pandas would also be acceptable. If you don't have the time or the interest, no big deal, great to get all those cases fixes in any case.

@datapythonista datapythonista merged commit 46e1c60 into pandas-dev:main May 27, 2025
8 checks passed
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.

2 participants