]> git.lizzy.rs Git - rust.git/commitdiff
Modify CharIndices' description
authorDonnie Bishop <donnie.a.bishop@gmail.com>
Thu, 30 Mar 2017 19:46:41 +0000 (15:46 -0400)
committerDonnie Bishop <donnie.a.bishop@gmail.com>
Thu, 30 Mar 2017 19:46:41 +0000 (15:46 -0400)
src/libcore/str/mod.rs

index 4556d41dd0a5ab384ab1295ec6b5f89f04d44116..4720c965c57cedd0490621583a49dec54b20d97e 100644 (file)
@@ -553,7 +553,15 @@ pub fn as_str(&self) -> &'a str {
     }
 }
 
-/// Iterator for a string's characters and their byte offsets.
+/// An iterator over the [`char`]s of a string slice, and their positions.
+///
+/// [`char`]: ../../std/primitive.char.html
+///
+/// This struct is created by the [`char_indices()`] method on [`str`].
+/// See its documentation for more.
+///
+/// [`char_indices()`]: ../../std/primitive.str.html#method.char_indices
+/// [`str`]: ../../std/primitive.str.html
 #[derive(Clone, Debug)]
 #[stable(feature = "rust1", since = "1.0.0")]
 pub struct CharIndices<'a> {