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

Properly link up iterator documentation #29027

Merged
merged 1 commit into from
Oct 20, 2015
Merged

Conversation

steveklabnik
Copy link
Member

Due to the way iterators work, the std::iter module is chock full of
structs that you, humble Rust programmer, will never actually use.
However, they have URLs, and therefore get linked to, because they are
real structs that do exist.

So, rather than just have a tiny sentence about each one of them,
this patch adds links back to the functions and methods on Iterator
which actually create the structs, where helpful documentation already
exists.

@rust-highfive
Copy link
Collaborator

r? @brson

(rust_highfive has picked a reviewer for you, use r? to override)

@alexcrichton
Copy link
Member

@bors: r+ 330d5bc521660261f685c6d71102f6cbe846fb80 rollup

@@ -2095,7 +2149,7 @@ impl<I> Iterator for Enumerate<I> where I: Iterator {

#[stable(feature = "rust1", since = "1.0.0")]
impl<I> DoubleEndedIterator for Enumerate<I> where
I: ExactSizeIterator + DoubleEndedIterator
Copy link
Member

Choose a reason for hiding this comment

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

This shouldn't have happened

Copy link
Member Author

Choose a reason for hiding this comment

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

whoah, whoops :(

@Manishearth
Copy link
Member

@bors r-
till tests pass

bors added a commit that referenced this pull request Oct 14, 2015
@steveklabnik steveklabnik force-pushed the iter_docs branch 2 times, most recently from 4a383ba to 302de36 Compare October 14, 2015 12:39
Due to the way iterators work, the std::iter module is chock full of
structs that you, humble Rust programmer, will never actually use.
However, they have URLs, and therefore get linked to, because they are
real structs that do exist.

So, rather than just have a tiny sentence about each one of them,
this patch adds links back to the functions and methods on Iterator
which actually create the structs, where helpful documentation already
exists.
@steveklabnik
Copy link
Member Author

@bors: r=manishearth rollup

@bors
Copy link
Contributor

bors commented Oct 19, 2015

📌 Commit 302de36 has been approved by manishearth

@steveklabnik
Copy link
Member Author

passed on travis now

steveklabnik added a commit to steveklabnik/rust that referenced this pull request Oct 19, 2015
Due to the way iterators work, the std::iter module is chock full of
structs that you, humble Rust programmer, will never actually use.
However, they have URLs, and therefore get linked to, because they are
real structs that do exist.

So, rather than just have a tiny sentence about each one of them,
this patch adds links back to the functions and methods on Iterator
which actually create the structs, where helpful documentation already
exists.
steveklabnik added a commit to steveklabnik/rust that referenced this pull request Oct 19, 2015
Due to the way iterators work, the std::iter module is chock full of
structs that you, humble Rust programmer, will never actually use.
However, they have URLs, and therefore get linked to, because they are
real structs that do exist.

So, rather than just have a tiny sentence about each one of them,
this patch adds links back to the functions and methods on Iterator
which actually create the structs, where helpful documentation already
exists.
bors added a commit that referenced this pull request Oct 19, 2015
@bors bors merged commit 302de36 into rust-lang:master Oct 20, 2015
@steveklabnik steveklabnik deleted the iter_docs branch June 19, 2016 20:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants