Hint which style_edition to use instead of version #6361
Conversation
| Use `style_edition=\"{0}\"` instead.", | ||
| match self.version.2 { | ||
| Version::One => "2015", | ||
| Version::Two => "2024", | ||
| } |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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.
ravvio
force-pushed
the
add-version-to-style-edition-hint
branch
from
3de0653 to
1db47e9
Compare
ytmimi
force-pushed
the
add-version-to-style-edition-hint
branch
from
1db47e9 to
ba4552c
Compare
ytmimi
added
release-notes
To resolve #6340.
Did not add too many information as to maintain succinct the warnings. I don't know if a link to relevant info in the warning would be useful.