Rollup merge of #23499 - mbrubeck:doc-edit, r=huonw

Multiple people have been suprised by this aspect of read_line's behavior, which is not obvious from the docs.
This commit is contained in:
Manish Goregaokar 2015-03-20 05:31:00 +05:30
commit 90e7f472f7
1 changed files with 2 additions and 1 deletions

View File

@ -584,7 +584,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