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

Jump to bottom

Write better module-level docs for std::iter #28914

Merged
merged 1 commit into from Oct 12, 2015
Merged

Write better module-level docs for std::iter #28914

merged 1 commit into from Oct 12, 2015

Conversation

steveklabnik
Copy link
Member

This replaces what was there with a comprehensive overview.

Thanks to @Hoverbear for suggesting that these docs needed improvement.

@rust-highfive
Copy link
Collaborator

r? @pcwalton

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

Tinche
Tinche reviewed Oct 8, 2015
View changes
src/libcore/iter.rs
@@ -8,51 +8,278 @@
// option. This file may not be copied, modified, or distributed
// except according to those terms.

//! Composable external iterators
//! Composable external iteratoration
Copy link

Choose a reason for hiding this comment

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

Should probably be iteration?

❤️

Copy link
Contributor

Choose a reason for hiding this comment

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

Spelling mistake here? "iteratoration"

@steveklabnik
Copy link
Member Author

Updated!

@steveklabnik
Copy link
Member Author

So, I rendered these locally to check all the links, but I'm getting a JavaScript error:

ReferenceError: initSidebarItems is not defined

I'm not modifying any JS here... so I'm confused. any ideas?

@steveklabnik
Copy link
Member Author

re-building made that go away. No clue.

@steveklabnik
Copy link
Member Author

This is good to go 👍

@steveklabnik
Copy link
Member Author

r? @alexcrichton

alexcrichton
alexcrichton reviewed Oct 11, 2015
View changes
src/libcore/iter.rs
//!
//! # The `Iterator` trait
//! If you've found yourself with a collection of some kind, and needed to perform an operation on
Copy link
Member

Choose a reason for hiding this comment

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

"obligatory 80 char reminder"

@alexcrichton
Copy link
Member

Wow super nice docs, thanks @steveklabnik!

@steveklabnik
Copy link
Member Author

Updated!

@alexcrichton
Copy link
Member

@bors: r+ 2f9f263

bors added a commit that referenced this pull request Oct 12, 2015
@bors
Auto merge of #28914 - steveklabnik:doc_iterator, r=alexcrichton
9f0b403 
This replaces what was there with a comprehensive overview.

Thanks to @Hoverbear for suggesting that these docs needed improvement.
@bors
Copy link
Contributor

bors commented Oct 12, 2015

⌛ Testing commit 2f9f263 with merge 9f0b403...

@bors
Copy link
Contributor

bors commented Oct 12, 2015

💔 Test failed - auto-mac-64-opt

@steveklabnik
Copy link
Member Author

@bors: r=alexcrichton 1fbf8bb

@bors
Copy link
Contributor

bors commented Oct 12, 2015

⌛ Testing commit 1fbf8bb with merge 8aa621a...

bors added a commit that referenced this pull request Oct 12, 2015
@bors
Auto merge of #28914 - steveklabnik:doc_iterator, r=alexcrichton
8aa621a 
This replaces what was there with a comprehensive overview.

Thanks to @Hoverbear for suggesting that these docs needed improvement.
@steveklabnik
Write better module-level docs for std::iter
1fbf8bb 
This replaces what was there with a comprehensive overview.
@steveklabnik
Copy link
Member Author

a whitespace snuck in at the end 😭

@bors
Copy link
Contributor

bors commented Oct 12, 2015

💔 Test failed - auto-mac-32-opt

@steveklabnik
Copy link
Member Author

@bors: retry

@bors
Copy link
Contributor

bors commented Oct 12, 2015

⚡ Previous build results for auto-mac-64-nopt-t, auto-mac-64-opt, auto-win-msvc-32-opt are reusable. Rebuilding only auto-linux-32-nopt-t, auto-linux-32-opt, auto-linux-64-nopt-t, auto-linux-64-opt, auto-linux-64-x-android-t, auto-mac-32-opt, auto-win-gnu-32-nopt-t, auto-win-gnu-32-opt, auto-win-gnu-64-nopt-t, auto-win-gnu-64-opt, auto-win-msvc-64-opt...

@bors
Copy link
Contributor

bors commented Oct 12, 2015

💔 Test failed - auto-linux-64-nopt-t

@alexcrichton
Copy link
Member

@bors: retry

On Mon, Oct 12, 2015 at 9:44 AM, bors notifications@github.com wrote:

[image: 💔] Test failed - auto-linux-64-nopt-t
http://buildbot.rust-lang.org/builders/auto-linux-64-nopt-t/builds/6675

—
Reply to this email directly or view it on GitHub
#28914 (comment).

@bors
Copy link
Contributor

bors commented Oct 12, 2015

⚡ Previous build results for auto-linux-32-nopt-t, auto-linux-64-opt, auto-mac-32-opt, auto-mac-64-nopt-t, auto-mac-64-opt, auto-win-msvc-32-opt are reusable. Rebuilding only auto-linux-32-opt, auto-linux-64-nopt-t, auto-linux-64-x-android-t, auto-win-gnu-32-nopt-t, auto-win-gnu-32-opt, auto-win-gnu-64-nopt-t, auto-win-gnu-64-opt, auto-win-msvc-64-opt...

@bors
Copy link
Contributor

bors commented Oct 12, 2015

☀️ Test successful - auto-linux-32-nopt-t, auto-linux-32-opt, auto-linux-64-nopt-t, auto-linux-64-opt, auto-linux-64-x-android-t, auto-mac-32-opt, auto-mac-64-nopt-t, auto-mac-64-opt, auto-win-gnu-32-nopt-t, auto-win-gnu-32-opt, auto-win-gnu-64-nopt-t, auto-win-gnu-64-opt, auto-win-msvc-32-opt, auto-win-msvc-64-opt

@bors bors merged commit 1fbf8bb into rust-lang:master Oct 12, 2015
@steveklabnik
Copy link
Member Author

@bors: r=alexcrichton

@steveklabnik
Copy link
Member Author

ah, so this was merged. cool.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@alexcrichton alexcrichton

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
9 participants
@steveklabnik @rust-highfive @alexcrichton @bors @Hoverbear @frewsxcv @andrew-d @Tinche @pcwalton