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

Remove unnecessary :func: & :meth: parentheses from reST content #12848

Conversation

mattwang44
Copy link
Contributor

Subject: Remove unnecessary :func: parentheses

Feature or Bugfix

  • Bugfix (doc)

Purpose

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

Detail

  • fix unnecessary :func: parentheses under doc.

Relates

resolve #12847

@mattwang44 mattwang44 changed the title Remove unnecessary :func: parentheses Remove unnecessary :func: parentheses from reST content Aug 30, 2024
@mattwang44 mattwang44 changed the title Remove unnecessary :func: parentheses from reST content Remove unnecessary :func: & :meth: parentheses from reST content Aug 30, 2024
@mattwang44
Copy link
Contributor Author

Fix up the meth roles too, as suggested by @AA-Turner (ref).

@AA-Turner AA-Turner merged commit e35e7b0 into sphinx-doc:master Sep 1, 2024
7 checks passed
@mattwang44 mattwang44 deleted the fix-unnecessary-parentheses-in-rst-content branch September 1, 2024 13:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Remove unnecessary :func: & :meth: parentheses from reST content
3 participants