std: Refining crate docs #26977
std: Refining crate docs #26977
Conversation
| //! | ||
| //! Furthermore, the standard library defines [The Rust | ||
| //! Prelude](prelude/index.html), a small collection of items, mostly | ||
| //! traits, that are imported into and available in every module. | ||
| //! traits, that are imported into every module and through trait | ||
| //! resolution provide Rust with much of its *standard flavor*. |
There was a problem hiding this comment.
This whole paragraph is one sentence.
|
Sweet improvement. |
|
What really else can i add after that @gankro review, heh :) 🎊 this is great, I agree with most of the nits. |
| //! | ||
| //! Thirdly, the standard library defines [The Rust | ||
| //! Prelude](prelude/index.html), a small collection of items - mostly | ||
| //! traits - that are imported into every module. The traits in the |
There was a problem hiding this comment.
into every module of every other non-std crate?
There was a problem hiding this comment.
Yes, I'll try to clarify.
Yet another attempt to make the prose on the std crate page clearer and more informative. This does a lot of things: tightens up the opening, adds useful links (including a link to the search bar), offers guidance on how to use the docs, and expands the prelude docs as a useful newbie entrypoint.
|
Feedback addressed. |
| //! [`Eq`](../cmp/trait.Eq.html), | ||
| //! [`Ord`](../cmp/trait.Ord.html) | ||
| //! }. | ||
| //! The comparision traits, which implement the comparison operators |
|
r=me with final nits addressed. |
|
Oh and travis is mad: |
|
@bors r=Gankro rollup |
|
📌 Commit 6d5ae6b has been approved by |
|
@bors r- |
|
@bors r=Gankro |
|
📌 Commit 2881bba has been approved by |
|
Awesome! 🎆 |
|
|
||
| // Sets the focus on the search bar at the top of the page | ||
| function focusSearchBar() { | ||
| document.getElementsByName('search')[0].focus(); |
There was a problem hiding this comment.
looks like duplicates https://github.com/brson/rust/blob/stddoc/src/librustdoc/html/static/main.js#L118
There was a problem hiding this comment.
Yes, good catch! Do you mind posting a follow up PR to refactor this?
There was a problem hiding this comment.
sure, will do when this is merged
There was a problem hiding this comment.
Oh, I didn't realize this hadn't landed yet... anyway it's in a roll up now, so I'm not going to touch it.
Yet another attempt to make the prose on the std crate page clearer and more informative. This does a lot of things: tightens up the opening, adds useful links (including a link to the search bar), offers guidance on how to use the docs, and expands the prelude docs as a useful newbie entrypoint. r? @steveklabnik cc @aturon
Following up on comment from rust-lang#26977. r? @brson
Yet another attempt to make the prose on the std crate page
clearer and more informative.
This does a lot of things: tightens up the opening, adds useful links
(including a link to the search bar), offers guidance on how to use
the docs, and expands the prelude docs as a useful newbie entrypoint.
r? @steveklabnik cc @aturon