Add links to missing related options within rule documentations #13971
Conversation
This file contains 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
Rule "hardcoded-temp-file" (S108) makes use of the option `lint.flake8-bandit.hardcoded-tmp-directory`. This commit adds the link to that option within the rule's documentation.
Rule "incorrectly-parenthesized-tuple-in-subscript" (RUF031) makes use of the option `lint.ruff.parenthesize-tuple-in-subscript`. This commit adds the link to that option within the rule's documentation.
Rule "magic-value-comparison" (PLR2004) makes use of the option `lint.pylint.allow-magic-value-types`. This commit adds the link to that option within the rule's documentation.
Rule "unused-import" (F401) makes use of the option `lint.pyflakes.allowed-unused-imports`. This commit adds the link to that option within the rule's documentation.
|
How did you find these? |
|
Just searching manually. I looked at the settings page and compared which rules from that namespace might be using that settings, then checked that the rule linked to that settings. It would be great to have some more automated way to ensure related settings and rules are linked together. |
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
No description provided.