Skip to content

std: Refining crate docs #26977

New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Merged
merged 5 commits into from
Jul 17, 2015
Merged

std: Refining crate docs #26977

merged 5 commits into from
Jul 17, 2015

Conversation

brson
Copy link
Contributor

@brson brson commented Jul 11, 2015

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

//!
//! 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*.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This whole paragraph is one sentence.

@Gankra
Copy link
Contributor

Gankra commented Jul 11, 2015

Sweet improvement.

@steveklabnik
Copy link
Member

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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

into every module of every other non-std crate?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I'll try to clarify.

brson added 3 commits July 13, 2015 17:56
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.
@brson
Copy link
Contributor Author

brson commented Jul 14, 2015

Feedback addressed.

//! [`Eq`](../cmp/trait.Eq.html),
//! [`Ord`](../cmp/trait.Ord.html)
//! }.
//! The comparision traits, which implement the comparison operators
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

comparision comparison

@Gankra
Copy link
Contributor

Gankra commented Jul 14, 2015

r=me with final nits addressed.

@Gankra
Copy link
Contributor

Gankra commented Jul 14, 2015

Oh and travis is mad:

/home/travis/build/rust-lang/rust/src/libstd/lib.rs:135: trailing whitespace

/home/travis/build/rust-lang/rust/src/libstd/lib.rs:150: trailing whitespace

@brson
Copy link
Contributor Author

brson commented Jul 14, 2015

@bors r=Gankro rollup

@bors
Copy link
Collaborator

bors commented Jul 14, 2015

📌 Commit 6d5ae6b has been approved by Gankro

@Gankra
Copy link
Contributor

Gankra commented Jul 14, 2015

@bors r-

@brson
Copy link
Contributor Author

brson commented Jul 14, 2015

@bors r=Gankro

@bors
Copy link
Collaborator

bors commented Jul 14, 2015

📌 Commit 2881bba has been approved by Gankro

@Gankra
Copy link
Contributor

Gankra commented Jul 14, 2015

Awesome! 🎆


// Sets the focus on the search bar at the top of the page
function focusSearchBar() {
document.getElementsByName('search')[0].focus();
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, good catch! Do you mind posting a follow up PR to refactor this?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sure, will do when this is merged

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Manishearth added a commit to Manishearth/rust that referenced this pull request Jul 16, 2015
 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
@bors bors merged commit 2881bba into rust-lang:master Jul 17, 2015
@tamird tamird mentioned this pull request Jul 17, 2015
Manishearth added a commit to Manishearth/rust that referenced this pull request Jul 17, 2015
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

9 participants