Clarify in docs that BufRead::read_line appends

Multiple people have been suprised by this aspect of read_line's behavior,
which is not obvious from the docs.

1 files changed, 2 insertions, 1 deletions

diff --git a/src/libstd/io/mod.rs b/src/libstd/io/mod.rs
index d9e8047104a..99c65927734 100644
--- a/src/libstd/io/mod.rs
+++ b/src/libstd/io/mod.rs
@@ -592,7 +592,8 @@ pub trait BufRead: Read {
         read_until(self, byte, buf)
     }
 
-    /// Read all bytes until a newline byte (the 0xA byte) is reached.
+    /// Read all bytes until a newline byte (the 0xA byte) is reached, and
+    /// append them to the provided buffer.
     ///
     /// This function will continue to read (and buffer) bytes from the
     /// underlying stream until the newline delimiter (the 0xA byte) or EOF is