Skip to content

Commit 5d14ccb

Browse files
committed
Modify EncodeUtf16's description
1 parent 17b4884 commit 5d14ccb

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

src/libcollections/str.rs

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -133,9 +133,15 @@ impl<S: Borrow<str>> SliceConcatExt<str> for [S] {
133133
}
134134
}
135135

136-
/// External iterator for a string's UTF-16 code units.
136+
/// An iterator of [`u16`] over the string encoded as UTF-16.
137137
///
138-
/// For use with the `std::iter` module.
138+
/// [`u16`]: ../../std/primitive.u16.html
139+
///
140+
/// This struct is created by the [`encode_utf16()`] method on [`str`].
141+
/// See its documentation for more.
142+
///
143+
/// [`encode_utf16()`]: ../../std/primitive.str.html#method.encode_utf16
144+
/// [`str`]: ../../std/primitive.str.html
139145
#[derive(Clone)]
140146
#[stable(feature = "encode_utf16", since = "1.8.0")]
141147
pub struct EncodeUtf16<'a> {

0 commit comments

Comments
 (0)