Skip to content

Commit 41e0498

Browse files
committed
Modify CharIndices' description
1 parent 0f5cf54 commit 41e0498

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

src/libcore/str/mod.rs

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -553,7 +553,15 @@ impl<'a> Chars<'a> {
553553
}
554554
}
555555

556-
/// Iterator for a string's characters and their byte offsets.
556+
/// An iterator over the [`char`]s of a string slice, and their positions.
557+
///
558+
/// [`char`]: ../../std/primitive.char.html
559+
///
560+
/// This struct is created by the [`char_indices()`] method on [`str`].
561+
/// See its documentation for more.
562+
///
563+
/// [`char_indices()`]: ../../std/primitive.str.html#method.char_indices
564+
/// [`str`]: ../../std/primitive.str.html
557565
#[derive(Clone, Debug)]
558566
#[stable(feature = "rust1", since = "1.0.0")]
559567
pub struct CharIndices<'a> {

0 commit comments

Comments
 (0)