improve docs for Index and IndexMut #37438

Cobrand · 2016-10-27T23:51:19Z

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

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

rust-highfive · 2016-10-27T23:51:34Z

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 · 2016-10-28T04:21:51Z

r? @steveklabnik

GuillaumeGomez

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

GuillaumeGomez · 2016-10-28T13:59:00Z

src/libcore/ops.rs

+/// `container[index]` is actually syntactic sugar for `*container.index(index)`,
+/// but only when used as an immutable value. If a mutable value is requested,
+/// `IndexMut` is used instead. This allows nice things such as
+/// `let value = v[index]` if `value` implements `Copy`.


Missing Copy trait url.

GuillaumeGomez · 2016-10-28T13:59:20Z

src/libcore/ops.rs

@@ -1879,10 +1879,15 @@ shr_assign_impl_all! { u8 u16 u32 u64 usize i8 i16 i32 i64 isize }
 /// The `Index` trait is used to specify the functionality of indexing operations
 /// like `container[index]` when used in an immutable context.
 ///
+/// `container[index]` is actually syntactic sugar for `*container.index(index)`,
+/// but only when used as an immutable value. If a mutable value is requested,
+/// `IndexMut` is used instead. This allows nice things such as


Missing url for IndexMut.

GuillaumeGomez · 2016-10-28T13:59:46Z

src/libcore/ops.rs

+///
+/// `container[index]` is actually syntactic sugar for
+/// `*container.index_mut(index)`, but only when used as a mutable value. If
+/// an immutable value is requested, the `Index` trait is used instead. This


Missing url for Index.

GuillaumeGomez · 2016-10-28T13:59:56Z

src/libcore/ops.rs

+/// `container[index]` is actually syntactic sugar for
+/// `*container.index_mut(index)`, but only when used as a mutable value. If
+/// an immutable value is requested, the `Index` trait is used instead. This
+/// allows nice things such as `v[index] = value` if `value` implements `Copy`.


Missing url for Copy.

GuillaumeGomez · 2016-10-28T14:00:22Z

src/libcore/ops.rs

-/// A trivial implementation of `IndexMut` for a type `Foo`. When `&mut Foo[2]`
-/// happens, it ends up calling `index_mut`, and therefore, `main` prints
-/// `Mutable indexing with 2!`.
+/// A very simple implementation of a Balance struct that has two sides, where


"of a Balance struct"

GuillaumeGomez · 2016-10-28T14:01:21Z

src/libcore/ops.rs

-///         self
+/// impl Index<Side> for Balance {
+///     type Output = Weight;
+///     fn index<'a>(&'a self, index: Side) -> &'a Weight {


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

GuillaumeGomez · 2016-10-28T14:02:14Z

src/libcore/ops.rs

+///         println!("Accessing {:?}-side of balance mutably", index);
+///         match index {
+///             Side::Left => &mut self.left,
+///             Side::Right => &mut self.right


Missing comma at the end of the line.

GuillaumeGomez · 2016-10-28T14:02:35Z

src/libcore/ops.rs

+///         left: Weight::Pound(1.5)
+///     };
+///
+///     // in this case balance[Side::Right] is sugar for


"in" -> "In"

GuillaumeGomez · 2016-10-28T14:02:49Z

src/libcore/ops.rs

+///     // balance[Side::Right], not writing it.
+///     assert_eq!(balance[Side::Right],Weight::Kilogram(2.5));
+///
+///     // however in this case balance[Side::Left] is sugar for


"however" -> "However"

GuillaumeGomez · 2016-10-28T14:03:08Z

src/libcore/ops.rs

 /// }
+///


Please remove this empty line.

Cobrand · 2016-10-28T15:21:08Z

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

GuillaumeGomez · 2016-10-28T17:26:04Z

Thanks!

@bors: r+ rollup

bors · 2016-10-28T17:26:05Z

📌 Commit 6768edd has been approved by GuillaumeGomez

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

Rollup of 5 pull requests - Successful merges: #37438, #37458, #37462, #37475, #37486 - Failed merges:

rust-highfive assigned sfackler Oct 27, 2016

rust-highfive assigned steveklabnik and unassigned sfackler Oct 28, 2016

Cobrand force-pushed the index_doc branch from 41c0ef4 to db1e936 Compare October 28, 2016 09:50

GuillaumeGomez requested changes Oct 28, 2016

View reviewed changes

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

improve docs for Index and IndexMut

6768edd

Cobrand force-pushed the index_doc branch from 4c2ef89 to 6768edd Compare October 28, 2016 15:19

GuillaumeGomez approved these changes Oct 28, 2016

View reviewed changes

GuillaumeGomez mentioned this pull request Oct 31, 2016

Rollup of 5 pull requests #37494

Merged

steveklabnik assigned GuillaumeGomez and unassigned steveklabnik Oct 31, 2016

bors added a commit that referenced this pull request Oct 31, 2016

Auto merge of #37494 - GuillaumeGomez:rollup, r=GuillaumeGomez

bf5b824

Rollup of 5 pull requests - Successful merges: #37438, #37458, #37462, #37475, #37486 - Failed merges:

bors merged commit 6768edd into rust-lang:master Oct 31, 2016

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

improve docs for Index and IndexMut #37438

improve docs for Index and IndexMut #37438

Cobrand commented Oct 27, 2016

rust-highfive commented Oct 27, 2016

sfackler commented Oct 28, 2016

GuillaumeGomez left a comment •

edited

Loading

GuillaumeGomez Oct 28, 2016

GuillaumeGomez Oct 28, 2016

GuillaumeGomez Oct 28, 2016

GuillaumeGomez Oct 28, 2016

GuillaumeGomez Oct 28, 2016

GuillaumeGomez Oct 28, 2016

GuillaumeGomez Oct 28, 2016

GuillaumeGomez Oct 28, 2016

GuillaumeGomez Oct 28, 2016

GuillaumeGomez Oct 28, 2016

Cobrand commented Oct 28, 2016

GuillaumeGomez commented Oct 28, 2016

bors commented Oct 28, 2016

improve docs for Index and IndexMut #37438

improve docs for Index and IndexMut #37438

Conversation

Cobrand commented Oct 27, 2016

rust-highfive commented Oct 27, 2016

sfackler commented Oct 28, 2016

GuillaumeGomez left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Cobrand commented Oct 28, 2016

GuillaumeGomez commented Oct 28, 2016

bors commented Oct 28, 2016

GuillaumeGomez left a comment •

edited

Loading