Remove unnecessary parentheses from doc #13193
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
StanFromIreland
approved these changes
Dec 29, 2024
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Feature or Bugfix
Purpose
Parentheses after the method name under
:meth:role is reported as unnecessary by sphinx-lint as of version 1.0.0. This PR removes the parentheses to avoid such reports.It might not be caught when running the sphinx-lint in the docs because the changed file is a Python file, not a reStructuredText, but it does get caught in translation files. See this lint output in CI and the corresponding translation file at sphinx-doc-translations.
Detail
Relates