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.

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

Update guide to reference Rust 2021 when giving examples of editions in general #257

Closed
rylev opened this issue Jul 19, 2021 · 4 comments
Closed
Assignees
Labels
Edition-2021 Edition 2021

Comments

@rylev
Copy link
Member

rylev commented Jul 19, 2021

Where the guide talks about migrations and editions in general, it usually refers to Rust 2018. We should update these references to be Rust 2021 since the majority of readers will be coming for that edition.

Of course, this needs to be timed for when the edition is stable.

This is already at least partially addressed by #254 (which is waiting for stabilization before merging).

@m-ou-se
Copy link
Member

m-ou-se commented Sep 3, 2021

Is there anything left to be done here?

(cc @ehuss)

@rylev
Copy link
Member Author

rylev commented Sep 3, 2021

There's still some work to do here. For example, in the example migration, the guide migrates from 2015 to 2018. Perhaps less urgent is that the description of what editions are uses only examples from Rust 2018.

@rylev rylev self-assigned this Sep 3, 2021
@ehuss
Copy link
Contributor

ehuss commented Sep 3, 2021

I intentionally left those as describing the 2018 changes. Those changes are pretty clear and simple to describe. Most of the migrations for 2021 are a bit more complicated, and I think could make it harder to understand. I'd also like to avoid needing to update the text for every edition (particularly if future editions have migrations that are even harder to describe). However, if you feel strongly about updating it, I won't object, but I probably won't change it myself.

@rylev
Copy link
Member Author

rylev commented Sep 6, 2021

@ehuss's justification seems reasonable to me. I took another look through the guide, and I'm sufficiently happy that it is in a good state for Rust 2021. As such I'm closing this issue.

@rylev rylev closed this as completed Sep 6, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Edition-2021 Edition 2021
Projects
None yet
Development

No branches or pull requests

3 participants