Improve prose around as_slice example of IterMut
#134619
Conversation
rustbot
added
S-waiting-on-review
|
@jhpratt want to take this one too? Thanks for reviewing my recent similar changes! |
This comment has been minimized.
This comment has been minimized.
| @@ -49,7 +49,7 @@ impl<'a, T> IntoIterator for &'a mut [T] { | |||
| /// // First, we need a slice to call the `iter` method on: | |||
| /// let slice = &[1, 2, 3]; | |||
| /// | |||
| /// // Then we call `iter` on the slice to get the `Iter` struct, | |||
There was a problem hiding this comment.
This is actually correct as-is. Given that it's documentation on the Iter type itself, there shouldn't be any confusion here. Likewise throughout.
There was a problem hiding this comment.
This is certainly correct, but later prose talks about calling the X method "of the iterator", without an iterator having been mentioned before. If you think it is less clear without struct, perhaps we can use something like "the Iter struct (which is an iterator)" or "the Iter struct (which implements the Iterator trait)"? What do you think?
| @@ -107,24 +107,20 @@ impl<'a, T> Iter<'a, T> { | |||
|
|
|||
| /// Views the underlying data as a subslice of the original data. | |||
| /// | |||
| /// This has the same lifetime as the original slice, and so the | |||
There was a problem hiding this comment.
AFAICT this is just normal borrowing rules and does not seem especially relevant here.
rustbot
added
S-waiting-on-author
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
I've removed the cryptic message about not being able to call `&mut self` methods while retaining a shared borrow of the iterator, such as `as_slice` produces. This is just normal borrowing rules and does not seem especially relevant here. I can whip up a replacement if someone thinks it has value.
|
@rustbot ready |
rustbot
added
S-waiting-on-review
I've removed the cryptic message about not being able to call
&mut selfmethods while retaining a shared borrow of the iterator, such asas_sliceproduces. This is just normal borrowing rules and does not seem especially relevant here. I can whip up a replacement if someone thinks it has value.