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

Prepare Edition Guide for Rust 2021 #82940

Closed
2 of 3 tasks
rylev opened this issue Mar 9, 2021 · 4 comments
Closed
2 of 3 tasks

Prepare Edition Guide for Rust 2021 #82940

rylev opened this issue Mar 9, 2021 · 4 comments
Labels
A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools A-edition-2021 Area: The 2021 edition

Comments

@rylev
Copy link
Member

rylev commented Mar 9, 2021

With rust-lang/rfcs#3085, there will be a new edition of Rust. This means we'll need to update the edition guide to handle the 2021 edition as well as any changes to edition process as whole. Concretely, this means the following subtasks:

@JohnTitor JohnTitor added the A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools label Mar 9, 2021
@ehuss
Copy link
Contributor

ehuss commented Mar 10, 2021

Do you mind clarifying a few things?

  • What machinery are you referring to?
  • If the guide is modified to only include edition-specific changes, that would shrink it considerably. Am I understanding the intent correctly? I think that would leave about 3 of the existing 80 pages.
    • If that is true, there is a lot of content that only exists in the edition-guide that would be good to move to other books. I think it would also be good to discuss if there should be better "what's new" documentation somewhere.

@rylev
Copy link
Member Author

rylev commented Mar 10, 2021

What machinery are you referring to?

This is indeed a very vague way to refer to it. I'm unfamiliar with if the edition guide is set up to refer to multiple editions, though it looks like it already refers to Rust 2015. We simply need to add references to Rust 2021 were appropriate. Hopefully this is very little work.

Am I understanding the intent correctly?

Yes, this is due to rust-lang/rfcs#3085 changing the intent of editions to be less about marketing all changes since the previous edition and more about just allowing breaking changes. Indeed, having some sort of more stylized change log would be helpful. Where this should go is a good question.

@ehuss ehuss added the A-edition-2021 Area: The 2021 edition label Apr 26, 2021
@nikomatsakis
Copy link
Contributor

See rust-lang/edition-guide#232. This lays a lot of the groundwork for this issue.

@nikomatsakis
Copy link
Contributor

This seems to be largely done, and there are specific issues for each piece. Going to close.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools A-edition-2021 Area: The 2021 edition
Projects
None yet
Development

No branches or pull requests

4 participants