Skip to content

Make the Iterator::enumerate doc example more clear #33085

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

Merged
merged 1 commit into from
Apr 25, 2016

Conversation

fitzgen
Copy link
Member

@fitzgen fitzgen commented Apr 18, 2016

The example uses integers for the value being iterated over, but the indices
added by enumerate are also integers, so I always end up double taking and
thinking harder than I should when parsing the documentation. I also always
forget which order the index and value are in the tuple so I frequently hit this
stumbling block. This commit changes the documentation to iterate over
characters so that it is immediately obvious which part of the tuple is the
index and which is the value.

@rust-highfive
Copy link
Contributor

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @brson (or someone else) soon.

If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes.

Please see the contribution instructions for more information.

@fitzgen
Copy link
Member Author

fitzgen commented Apr 18, 2016

r? @steveklabnik

@rust-highfive rust-highfive assigned steveklabnik and unassigned brson Apr 18, 2016
@steveklabnik
Copy link
Member

@bors: r+ rollup

thanks, I agree!

@bors
Copy link
Collaborator

bors commented Apr 19, 2016

📌 Commit 3210942 has been approved by steveklabnik

@bors
Copy link
Collaborator

bors commented Apr 22, 2016

☔ The latest upstream changes (presumably #33079) made this pull request unmergeable. Please resolve the merge conflicts.

@bors
Copy link
Collaborator

bors commented Apr 22, 2016

🔒 Merge conflict

The example uses integers for the value being iterated over, but the indices
added by `enumerate` are also integers, so I always end up double taking and
thinking harder than I should when parsing the documentation. I also always
forget which order the index and value are in the tuple so I frequently hit this
stumbling block. This commit changes the documentation to iterate over
characters so that it is immediately obvious which part of the tuple is the
index and which is the value.
@fitzgen fitzgen force-pushed the make-enumerate-example-more-clear branch from 3210942 to e078667 Compare April 22, 2016 17:29
@fitzgen
Copy link
Member Author

fitzgen commented Apr 22, 2016

Rebased!

@steveklabnik
Copy link
Member

@bors: r+ rollup

@bors
Copy link
Collaborator

bors commented Apr 23, 2016

📌 Commit e078667 has been approved by steveklabnik

@bors
Copy link
Collaborator

bors commented Apr 24, 2016

⌛ Testing commit e078667 with merge 1e7424b...

@bors
Copy link
Collaborator

bors commented Apr 24, 2016

💔 Test failed - auto-win-msvc-32-opt

@alexcrichton
Copy link
Member

@bors: retry

On Sat, Apr 23, 2016 at 9:11 PM, bors [email protected] wrote:

[image: 💔] Test failed - auto-win-msvc-32-opt
http://buildbot.rust-lang.org/builders/auto-win-msvc-32-opt/builds/3138


You are receiving this because you are subscribed to this thread.
Reply to this email directly or view it on GitHub
#33085 (comment)

@bors
Copy link
Collaborator

bors commented Apr 24, 2016

⌛ Testing commit e078667 with merge 8fcc5b1...

bors added a commit that referenced this pull request Apr 24, 2016
…teveklabnik

Make the `Iterator::enumerate` doc example more clear

The example uses integers for the value being iterated over, but the indices
added by `enumerate` are also integers, so I always end up double taking and
thinking harder than I should when parsing the documentation. I also always
forget which order the index and value are in the tuple so I frequently hit this
stumbling block. This commit changes the documentation to iterate over
characters so that it is immediately obvious which part of the tuple is the
index and which is the value.
@bors
Copy link
Collaborator

bors commented Apr 24, 2016

💔 Test failed - auto-win-msvc-32-opt

@alexcrichton
Copy link
Member

@bors: retry

On Sun, Apr 24, 2016 at 3:25 AM, bors [email protected] wrote:

[image: 💔] Test failed - auto-win-msvc-32-opt
http://buildbot.rust-lang.org/builders/auto-win-msvc-32-opt/builds/3142


You are receiving this because you commented.
Reply to this email directly or view it on GitHub
#33085 (comment)

@bors
Copy link
Collaborator

bors commented Apr 25, 2016

⌛ Testing commit e078667 with merge 645dd01...

bors added a commit that referenced this pull request Apr 25, 2016
…teveklabnik

Make the `Iterator::enumerate` doc example more clear

The example uses integers for the value being iterated over, but the indices
added by `enumerate` are also integers, so I always end up double taking and
thinking harder than I should when parsing the documentation. I also always
forget which order the index and value are in the tuple so I frequently hit this
stumbling block. This commit changes the documentation to iterate over
characters so that it is immediately obvious which part of the tuple is the
index and which is the value.
@bors bors merged commit e078667 into rust-lang:master Apr 25, 2016
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