Skip to content

Commit 1a1db55

Browse files
authored
Merge pull request #63 from eminence/transition_wording
Add some clarifying text to the transitioning steps.
2 parents c89be81 + 2904c01 commit 1a1db55

File tree

1 file changed

+14
-10
lines changed

1 file changed

+14
-10
lines changed

src/editions/transitioning.md

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -28,19 +28,22 @@ manually!
2828
2929
## The preview period
3030

31-
First, editions have a "preview" phase. This lets you try out the new edition
32-
in nightly Rust. During the preview, there's an extra step you need to take
33-
to opt in. At the time of writing, Rust 2018 is in its preview phase.
34-
35-
To do that, add this feature flag to your `lib.rs` or `main.rs`:
31+
Before an edition is released, it will have a "preview" phase which lets you
32+
try out the new edition in nightly Rust before its release. Currently Rust 2018
33+
is in its preview phase and because of this, there's an extra step you need to
34+
take to opt in. Add this feature flag to your `lib.rs` or `main.rs`:
3635

3736
```rust
3837
#![feature(rust_2018_preview)]
3938
```
4039

41-
This will ensure that you're enabling all of the relevant features. Note that
42-
during the time the preview is available, we may continue to add/enable new
43-
features with this flag!
40+
This will enable the unstable features listed in the [feature status][status]
41+
page. Note that some features require a miniumum of Rust 2018 and these features will
42+
require a Cargo.toml change to enable (described in the sections below). Also
43+
note that during the time the preview is available, we may continue to add/enable
44+
new features with this flag!
45+
46+
[status]: 2018/status.html
4447

4548
## Fix edition compatibility warnings
4649

@@ -55,7 +58,8 @@ $ cargo +nightly fix --prepare-for 2018 --all-targets --all-features
5558
This will instruct Cargo to compile all targets in your project (libraries,
5659
binaries, tests, etc.) while enabling all Cargo features and prepare them for
5760
the 2018 edition. Cargo will likely automatically fix a number of files,
58-
informing you as it goes along.
61+
informing you as it goes along. Note that this does not enable any new Rust
62+
2018 features; it only makes sure your code is compatible with Rust 2018.
5963

6064
If Cargo can't automatically fix everything it'll print out the remaining
6165
warnings. Continue to run the above command until all warnings have been solved.
@@ -66,7 +70,7 @@ You can explore more about the `cargo fix` command with:
6670
$ cargo +nightly fix --help
6771
```
6872

69-
## Commit to the next edition
73+
## Switch to the next edition
7074

7175
Once you're happy with those changes, it's time to use the new edition.
7276
Add this to your `Cargo.toml`:

0 commit comments

Comments
 (0)