You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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
This PR removes the --preview requirement for quote-style: preserve and changes the semantics of
the style to apply to all strings (including triple quoted and doc-strings).
The motivation for changing the semantic to apply to all strings is:
The option is intended as a replacement for black's --skip-string-normalization that applies to all strings
The option is intended for projects that can't enforce a consistent quote style. These are mainly projects that want to use a formatter but can't agree on a single quote style or changing all strings leads to too large diffs. Allowing these users to use a formatter is more important than being opinionated on the quote style
We received reports that users were surprised that preserve didn't apply to all strings.
is this PR is going to merge for next patch release? it is unknown in versioning policy how config options changes should be applied.
Yes, this will ship as part of the next patch release. Changing the semantic is is in line with our versioning policy because quote-style: preserve is in preview:
The preview mode is not intended to gate access to work that is incomplete or features that we are likely to remove. However, we reserve the right to make changes to any behavior gated by the mode including the removal of preview features or rules. source
This PR removes the `--preview` requirement for
`quote-style: preserve` and changes the semantics of
the style to apply to all strings (including triple quoted and doc-strings).
The motivation for changing the semantic to apply to all strings is:
* The option is intended as a replacement for black's `--skip-string-normalization` that applies to all strings
* The option is intended for projects that can't enforce a consistent quote style. These are mainly projects that want to use a formatter but can't agree on a single quote style or changing all strings leads to too large diffs. Allowing these users to use a formatter is more important than being opinionated on the quote style
* We received reports that users were surprised that `preserve` didn't apply to all strings.
Fixes#9185
cliRelated to the command-line interfaceformatterRelated to the formatter
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.
This PR removes the
--previewrequirement forquote-style: preserveand changes the semantics ofthe style to apply to all strings (including triple quoted and doc-strings).
The motivation for changing the semantic to apply to all strings is:
--skip-string-normalizationthat applies to all stringspreservedidn't apply to all strings.Fixes #9185
Test Plan
cargo test. Reviewed the snapshot changes. Tested the CLI that usingquote-style: preservewithout the preview flag no longer aborts.