Docs: Explain why/when .lines() returns an error

rust-lang · Dec 21, 2016 · 24334a0 · 24334a0
1 parent 94ae2a2
commit 24334a0
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/src/libstd/io/mod.rs b/src/libstd/io/mod.rs
@@ -1425,6 +1425,12 @@ pub trait BufRead: Read {
     ///     println!("{}", line.unwrap());
     /// }
     /// ```
+    ///
+    /// # Errors
+    ///
+    /// Each line of the iterator has the same error semantics as [`BufRead::read_line()`].
+    ///
+    /// [`BufRead::read_line()`]: trait.BufRead.html#method.read_line
     #[stable(feature = "rust1", since = "1.0.0")]
     fn lines(self) -> Lines<Self> where Self: Sized {
         Lines { buf: self }