Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Hint which style_edition to use instead of version #6361

Merged
merged 1 commit into from
Oct 9, 2024
Merged

Hint which style_edition to use instead of version #6361

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion Configurations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
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
View file
Open in desktop
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",
}
Comment on lines +574 to +578
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

version=One is equivalent to 2015, 2018, or 2021. Do you think it would be useful to be a little more specific in the warning message?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If I understand correctly there is no difference between using 2015, 2018 or 2021 so I think it should be fine to give the "default" value as an hint in the warning, given that following it will give you the desired behavior. It could maybe useful to mention it in the docs so to not have to look it up in the tracking issue.

If we do that should the style_version=2027 also be added as an alternative for 2024?

Copy link
Contributor

@ytmimi ytmimi Oct 8, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mentioning it in the docs sounds good to me, and we can leave the warning message recommending the default value of 2015. We definitely don't want to recommend style_version=2027 as an alternative for 2024 since 2024 will be stabilized soon and 2027 is going to remain an unstable variant for now.

);

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