Skip to content
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

Adjust reference to unidiomatic syntax in std docs roots #56544

Closed
withoutboats opened this issue Dec 5, 2018 · 0 comments
Closed

Adjust reference to unidiomatic syntax in std docs roots #56544

withoutboats opened this issue Dec 5, 2018 · 0 comments
Labels
A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools P-medium Medium priority

Comments

@withoutboats
Copy link
Contributor

The opening section of the std documentation says this:

//! `std` is available to all Rust crates by default, just as if each one
//! contained an `extern crate std;` import at the [crate root]. Therefore the
//! standard library can be accessed in [`use`] statements through the path
//! `std`, as in [`use std::env`], or in expressions through the absolute path
//! `::std`, as in [`::std::env::args`].

This information, while accurate in both editions, is unidiomatic in the 2018 edition, in that it refers to extern crate syntax and double colon absolute paths. Perhaps this information could be reworded to be expressed in a more neutral way.

@withoutboats withoutboats added the A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools label Dec 5, 2018
@steveklabnik steveklabnik added the P-medium Medium priority label Dec 27, 2018
Centril added a commit to Centril/rust that referenced this issue Jan 23, 2019
Update std/lib.rs docs to reflect Rust 2018 usage

Fixes rust-lang#56544

This paragraph was written for Rust 2015.  Since 2018 has been stable for a while I think we can update it.
@bors bors closed this as completed in e7b584c Jan 24, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools P-medium Medium priority
Projects
None yet
Development

No branches or pull requests

2 participants