Fix documentation for DecodeUtf16Error

tromey · tromey · commit 47acc4bd8440 · 2017-12-01T11:33:42.000-07:00
Fixes #46307
diff --git a/src/libstd_unicode/char.rs b/src/libstd_unicode/char.rs
@@ -1461,7 +1461,7 @@ pub struct DecodeUtf16<I>
     buf: Option<u16>,
 }
 
-/// An iterator that decodes UTF-16 encoded code points from an iterator of `u16`s.
+/// An error that can be returned when decoding UTF-16 code points.
 #[stable(feature = "decode_utf16", since = "1.9.0")]
 #[derive(Debug, Clone, Eq, PartialEq)]
 pub struct DecodeUtf16Error {

Original file line number	Diff line number	Diff line change
`@@ -1461,7 +1461,7 @@ pub struct DecodeUtf16<I>`
`1461`	`1461`	`buf: Option<u16>,`
`1462`	`1462`	`}`
`1463`	`1463`
`1464`		-/// An iterator that decodes UTF-16 encoded code points from an iterator of `u16`s.
	`1464`	`+/// An error that can be returned when decoding UTF-16 code points.`
`1465`	`1465`	`#[stable(feature = "decode_utf16", since = "1.9.0")]`
`1466`	`1466`	`#[derive(Debug, Clone, Eq, PartialEq)]`
`1467`	`1467`	`pub struct DecodeUtf16Error {`