Skip to content

Commit

Permalink
Hint which style_edition to use instead of version
Browse files Browse the repository at this point in the history
Update docs
  • Loading branch information
ravvio committed Oct 9, 2024
1 parent 5f48fe9 commit 1db47e9
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 3 deletions.
6 changes: 4 additions & 2 deletions Configurations.md
Original file line number Diff line number Diff line change
Expand Up @@ -2369,7 +2369,7 @@ specific version of rustfmt is used in your CI, use this option.

The width threshold for an array element to be considered "short".

The layout of an array is dependent on the length of each of its elements.
The layout of an array is dependent on the length of each of its elements.
If the length of every element in an array is below this threshold (all elements are "short") then the array can be formatted in the mixed/compressed style, but if any one element has a length that exceeds this threshold then the array elements will have to be formatted vertically.

- **Default value**: `10`
Expand Down Expand Up @@ -3062,7 +3062,9 @@ fn main() {

## `version`

This option is deprecated and has been replaced by [`style_edition`](#style_edition)
This option is deprecated and has been replaced by [`style_edition`](#style_edition).
`version = "One"` is equivalent to `style_edition = "(2015|2018|2021)"` and
`version = "Two"` is equivalent to `style_edition = "2024"`

- **Default value**: `One`
- **Possible values**: `One`, `Two`
Expand Down
6 changes: 5 additions & 1 deletion src/config/config_type.rs
Original file line number Diff line number Diff line change
Expand Up @@ -571,7 +571,11 @@ macro_rules! create_config {

eprintln!(
"Warning: the `version` option is deprecated. \
Use `style_edition` instead."
Use `style_edition=\"{0}\"` instead.",
match self.version.2 {
Version::One => "2015",
Version::Two => "2024",
}
);

if self.was_set().style_edition() || self.was_set_cli().style_edition() {
Expand Down

0 comments on commit 1db47e9

Please sign in to comment.