[Docs] Clear instruction for single quotes (linter and formatter) #12015
+2
−0
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
| @@ -196,6 +196,8 @@ As an example, the following would configure Ruff to: | |||
|
|
|||
| [tool.ruff.format] | |||
| # 5. Use single quotes for non-triple-quoted strings. | |||
| # (Note this only applies to the ruff formatter. To configure | |||
| # the ruff linter to also use single quotes, see [tool.ruff.lint.flake8-quotes]) | |||
There was a problem hiding this comment.
I'd prefer not to introduce this complexity in the example... What if we change "5. Use single quotes for non-triple-quoted strings." to something like "5. Use single quotes in ruff format."?
There was a problem hiding this comment.
(Most users won't / shouldn't need the flake8-quotes rules at all, especially if they're using the formatter.)
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.
Summary
In order to use single quotes with both the ruff linter and the ruff formatter,
two different rules must be applied. This was not clear to me when
internet searching "configure ruff single quotes" and it eventually
I filed this issue:
#12003
Test Plan
Please advise how to preview this documentation change.