Skip to content

Commit 325d3df

Browse files
committed
moar review feedback
1 parent 5d2baf0 commit 325d3df

File tree

1 file changed

+13
-10
lines changed

1 file changed

+13
-10
lines changed

src/editions/transitioning.md

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ re-write your code to comply with new features and idioms.
1717
1818
## Installing rustfix
1919

20-
You can get `rustfix` from crates.io. Given that you're probably using Cargo,
20+
You can get `rustfix` from GitHub, and eventually, `crates.io`. Given that you're probably using Cargo,
2121
you'll want to run this:
2222

2323
```shell
@@ -31,8 +31,9 @@ And that's it!
3131
Before we talk about how to move to the new edition, a reminder:
3232

3333

34-
* New editions may have features that are only available in the new edition.
35-
For example, `async`/`await` is available in Rust 2018, but not Rust 2015.
34+
* New editions might change the way you write Rust -- they add syntax,
35+
language, and library features but also remove others. For example,
36+
`async`/`await` is available in Rust 2018, but not Rust 2015.
3637
* It's our intention that the migration to new editions is as smooth an experience
3738
as possible. It's considered a bug if it's difficult to upgrade your crate to
3839
a new edition. If you have a difficult time then a bug should be filed
@@ -52,7 +53,9 @@ To do that, add this feature flag to your `lib.rs` or `main.rs`:
5253
#![feature(rust_2018_preview)]
5354
```
5455

55-
This will ensure that you're enabling all of the relevant features.
56+
This will ensure that you're enabling all of the relevant features. Note that
57+
during the time the preview is available, we may continue to add/enable new
58+
features with this flag!
5659

5760
### Running rustfix
5861

@@ -66,8 +69,8 @@ $ cargo +nightly fix --prepare-for 2018
6669

6770
This would turn on those lints, and fix up the project for the 2018 edition.
6871
If there's something that `rustfix` doesn't know how to fix automatically yet,
69-
the warning will be printed; you'll need to fix those manually. Do so
70-
until you get a run with no warnings.
72+
the usual compiler warning will be printed; you'll need to fix those
73+
manually. Do so until you get a run with no warnings.
7174

7275
## Commit to the next edition
7376

@@ -85,9 +88,9 @@ That `cargo-features` line should go at the very top; and `edition` goes into
8588
the `[package]` section. As mentioned above, right now this is a nightly-only
8689
feature of Cargo, so you need to enable it for things to work.
8790

88-
At this point, your project should compile with a regular old `cargo build`.
89-
However, since you've said you're using the new edition, you may get more
90-
warnings! Time to bust out `rustfix` again.
91+
At this point, your project should compile with a regular old `cargo +nightly
92+
build`. However, since you've said you're using the new edition, you may get
93+
more warnings! Time to bust out `rustfix` again.
9194

9295
## Fix new warnings
9396

@@ -97,4 +100,4 @@ To fix up these warnings, we can use `rustfix`:
97100
$ cargo +nightly fix
98101
```
99102

100-
This will fix up all of the new warnings. Congrats! You're done!
103+
This will try to fix up all of the new warnings. Congrats! You're done!

0 commit comments

Comments
 (0)