Skip to content

improve docs for Index and IndexMut #37438

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.

Sign up for GitHub

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
Merged
merged 1 commit into from
Oct 31, 2016
Merged

improve docs for Index and IndexMut #37438

merged 1 commit into from
Oct 31, 2016

Conversation

Cobrand
Copy link
Contributor

@Cobrand Cobrand commented Oct 27, 2016

This mainly changes the boring example of Foo/Bar of IndexMut into a better one.

Also added explanations about syntactic sugar for v[index].

Closes #36329

@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 @sfackler (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.

@sfackler
Copy link
Member

r? @steveklabnik

GuillaumeGomez
GuillaumeGomez requested changes Oct 28, 2016
View reviewed changes
Copy link
Member

@GuillaumeGomez GuillaumeGomez left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Excellent work! Just a few typos and should be good to go!

src/libcore/ops.rs Outdated
Copy link
Member

Choose a reason for hiding this comment

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

Missing Copy trait url.

src/libcore/ops.rs Outdated
Copy link
Member

Choose a reason for hiding this comment

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

Missing url for IndexMut.

src/libcore/ops.rs Outdated
Copy link
Member

Choose a reason for hiding this comment

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

Missing url for Index.

src/libcore/ops.rs Outdated
Copy link
Member

Choose a reason for hiding this comment

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

Missing url for Copy.

src/libcore/ops.rs Outdated
Copy link
Member

Choose a reason for hiding this comment

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

"of a Balance struct"

src/libcore/ops.rs Outdated
Copy link
Member

Choose a reason for hiding this comment

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

Please put an empty line before this one. It helps for the reading.

src/libcore/ops.rs Outdated
Copy link
Member

Choose a reason for hiding this comment

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

Missing comma at the end of the line.

src/libcore/ops.rs Outdated
Copy link
Member

Choose a reason for hiding this comment

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

"in" -> "In"

src/libcore/ops.rs Outdated
Copy link
Member

Choose a reason for hiding this comment

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

"however" -> "However"

src/libcore/ops.rs Outdated
Copy link
Member

Choose a reason for hiding this comment

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

Please remove this empty line.

@Cobrand Cobrand force-pushed the index_doc branch 2 times, most recently from 8347631 to 4c2ef89 Compare October 28, 2016 15:18
@Cobrand
Copy link
Contributor Author

Cobrand commented Oct 28, 2016

Thanks for the comments, I fixed what you said and it should be fine now.

@GuillaumeGomez
Copy link
Member

Thanks!

@bors: r+ rollup

@bors
Copy link
Collaborator

bors commented Oct 28, 2016

📌 Commit 6768edd has been approved by GuillaumeGomez

@GuillaumeGomez GuillaumeGomez mentioned this pull request Oct 31, 2016
Merged
GuillaumeGomez added a commit to GuillaumeGomez/rust that referenced this pull request Oct 31, 2016
@GuillaumeGomez
Rollup merge of rust-lang#37438 - Cobrand:index_doc, r=GuillaumeGomez
48def35 
improve docs for Index and IndexMut

This mainly changes the boring example of Foo/Bar of `IndexMut` into a better one.

Also added explanations about syntactic sugar for `v[index]`.

Closes rust-lang#36329
bors added a commit that referenced this pull request Oct 31, 2016
@bors
Auto merge of #37494 - GuillaumeGomez:rollup, r=GuillaumeGomez
bf5b824 
Rollup of 5 pull requests

- Successful merges: #37438, #37458, #37462, #37475, #37486
- Failed merges:
@bors bors merged commit 6768edd into rust-lang:master Oct 31, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@GuillaumeGomez GuillaumeGomez GuillaumeGomez approved these changes

Assignees

@GuillaumeGomez GuillaumeGomez

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@Cobrand @rust-highfive @sfackler @GuillaumeGomez @bors @steveklabnik