diff options
| author | Manish Goregaokar <manishsmail@gmail.com> | 2015-03-20 05:31:00 +0530 |
|---|---|---|
| committer | Manish Goregaokar <manishsmail@gmail.com> | 2015-03-20 12:43:13 +0530 |
| commit | 90e7f472f7b1a71998e0133f00b615524cc36a33 (patch) | |
| tree | 816597077d4477c5530a2940810375aa9b533e8f /src/libstd/io | |
| parent | dbe084b5bffae155b83f9229d04d83e7273bec4f (diff) | |
| parent | a7a28d709170f5dd14439c83d115e16a11c53c06 (diff) | |
| download | rust-90e7f472f7b1a71998e0133f00b615524cc36a33.tar.gz rust-90e7f472f7b1a71998e0133f00b615524cc36a33.zip | |
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.
Diffstat (limited to 'src/libstd/io')
| -rw-r--r-- | src/libstd/io/mod.rs | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/src/libstd/io/mod.rs b/src/libstd/io/mod.rs index 8691c84a462..237435d6dfb 100644 --- a/src/libstd/io/mod.rs +++ b/src/libstd/io/mod.rs @@ -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 |