Make Rust 2018 primary and use "Edition Differences" for Rust 2015 #698
Conversation
Documents the Rust 2015 rules only in "Edition Differences" sections.
Documents the Rust 2015 rules in an "Edition Differences" section.
Documents the Rust 2015 rules in an "Edition Differences" section.
|
As discussed on Discord, I've prepared some different forms of this patch series.
I've included changes to But those commits are changing the text as well as rearranging it, so I don't think they're really part of this PR. |
|
The intent was to have something like the "common primary" option, though there are some places where it was a little inconsistent. I think it will be difficult to have complete consistency, since some edition differences are large (like async/await, which just have brief callouts), so I suspect there will be a few special cases. I'm not entirely happy with the "common" approach since it is a little disjoint. Some of the large callout blocks look a little strange to me. But the other approaches have their own drawbacks (such as making it less clear where the edition differences are). If anything, I would vote for some of the "common" changes to make it more consistent. But I'd like to hear what other people think! |
|
I like the idea of the reference always describing the current edition of Rust, and separately stating how past editions differ. |
|
Closing: I don't think there's anything of value left here. The Reference is now essentially in "Common primary" style (and this is documented in STYLE.md). |
At present, some "Edition Differences" sections describe Rust 2018 additions to Rust 2015, some describe Rust 2015 limitations, and some are a mixture.
These commits attempt to make things consistent by putting the Rust 2018 description in the main text and information about Rust 2015 in the "Edition Differences" sections.
I've updated all the sections I could find, except for use-declarations.md
which needs more work (see #697).