-
Notifications
You must be signed in to change notification settings - Fork 2.5k
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
Outdated documentation for manifest edition field #8951
Comments
If you don't have an addition specified in your Cargo.toml then we use edition 2015. @ehuss pointed it out to me the last time I tried to "fix" this documentation. It is clearly confusing, as we keep getting PRs to change it. Is there a clearer way to explain what is ment? |
@Eh2406 Glad to hear I'm not the only person who got confused when reading this. After reading @ehuss 's comment and re-reading the section, it makes sense. I think the confusing part is that it is an optional key but running I reworded the edition section below. That makes sense to me, anyone else have any thoughts? The
|
Sounds reasonable. Want to make a PR with that clarification and we can wordsmith there? |
done, let's discuss here #8953 |
Clarify cargo manifest edition field docs addresses #8951 This PR aims to clarify the documentation for the `edition` field in the Cargo manifest. The confusion (IME) stems from the behavior of `cargo new` (defaults to writing edition = "2018") being confused for the default behavior of how Cargo interprets the manifest (`edition` is an optional key, defaults to 2015). would love to get some other thoughts on how we can clarify this since it seems like I'm not the only one who got confused `@Eh2406`
Problem
The current documentation specifies that the default value for the
edition
is 2015. I believe it should be 2018 (after doing a quick search for "rust edition" in this repository).Steps
Possible Solution(s)
Update the docs to reflect the new default value, 2018
(i have a PR on the way!)
Notes
Output of
cargo version
:The text was updated successfully, but these errors were encountered: