Skip to content

Commit

Permalink
Auto merge of #9233 - alexcrichton:reword-edition, r=ehuss
Browse files Browse the repository at this point in the history
Wordsmith the edition documentation a bit more

This hopes to clear up a few recent PRs about the `edition` key in the
manifest. It shuffles things around so the defaults are talked about in
two different paragraphs. The first one talks about how `cargo new` uses
the 2018 edition and is the only paragraph to use the word "default".
The second section talks about the usage of 2015 with no `edition` field
present.

This didn't end up being quite as clear as I hoped it might be, but I'm
hoping that this provides a bit more emphasis or otherwise just
restructures things a bit to be more clear.
  • Loading branch information
bors committed Mar 9, 2021
2 parents 0f3f47e + ce00667 commit ca476ab
Showing 1 changed file with 11 additions and 5 deletions.
16 changes: 11 additions & 5 deletions src/doc/src/reference/manifest.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,18 +120,24 @@ brackets at the end of each author.
#### The `edition` field

The `edition` key is an optional key that affects which [Rust Edition] your package
is compiled with. [`cargo new`] will generate a package with the `edition` key
set to the latest edition. Setting the `edition` key in
`[package]` will affect all targets/crates in the package, including test
suites, benchmarks, binaries, examples, etc.
is compiled with. Setting the `edition` key in `[package]` will affect all
targets/crates in the package, including test suites, benchmarks, binaries,
examples, etc.

```toml
[package]
# ...
edition = '2018'
```

If the `edition` key is not set in your `Cargo.toml`, Cargo will default to 2015.
Most manifests have the `edition` field filled in automatically by [`cargo new`]
with the latest stable edition. By default `cargo new` creates a manifest with
the 2018 edition currently.

If the `edition` field is not present in `Cargo.toml`, then the 2015 edition is
assumed for backwards compatibility. Note that all manifests
created with [`cargo new`] will not use this historical fallback because they
will have `edition` explicitly specified to a newer value.

#### The `description` field

Expand Down

0 comments on commit ca476ab

Please sign in to comment.