From 5d14ccbc96923607f6ab00810817885ee0939486 Mon Sep 17 00:00:00 2001
From: Donnie Bishop <donnie.a.bishop@gmail.com>
Date: Thu, 30 Mar 2017 16:35:19 -0400
Subject: Modify EncodeUtf16's description

---
 src/libcollections/str.rs | 10 ++++++++--
 1 file changed, 8 insertions(+), 2 deletions(-)

(limited to 'src')

diff --git a/src/libcollections/str.rs b/src/libcollections/str.rs
index 219e818f7d7..aee6861a09f 100644
--- a/src/libcollections/str.rs
+++ b/src/libcollections/str.rs
@@ -133,9 +133,15 @@ impl<S: Borrow<str>> SliceConcatExt<str> for [S] {
     }
 }
 
-/// External iterator for a string's UTF-16 code units.
+/// An iterator of [`u16`] over the string encoded as UTF-16.
 ///
-/// For use with the `std::iter` module.
+/// [`u16`]: ../../std/primitive.u16.html
+///
+/// This struct is created by the [`encode_utf16()`] method on [`str`].
+/// See its documentation for more.
+///
+/// [`encode_utf16()`]: ../../std/primitive.str.html#method.encode_utf16
+/// [`str`]: ../../std/primitive.str.html
 #[derive(Clone)]
 #[stable(feature = "encode_utf16", since = "1.8.0")]
 pub struct EncodeUtf16<'a> {
-- 
cgit 1.4.1-3-g733a5