Use ruff to lint for f-string doc strings in Pants repo #21018
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
huonw
force-pushed
the
huonw/lint-ruff-doc-strings
branch
from
2708f05 to
d53b775
Compare
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.
This continues #20984 by linting against that problem: a docstring should never be an f-strings, as it is silently ignored by the Python interpreter.
This configures linting against this by activating the ruff backend in this repo, and enabling the specific rule against it https://docs.astral.sh/ruff/rules/f-string-docstring/
Alternative: add
flake8-bugbeartoflake8.