about summary refs log tree commit diff
path: root/src/libstd
diff options
context:
space:
mode:
authorkennytm <kennytm@gmail.com>2018-09-12 12:17:28 +0800
committerGitHub <noreply@github.com>2018-09-12 12:17:28 +0800
commit3c9e884dd3bf93b1516d3b5858072b7659c4cfba (patch)
treea9eff1ee8714122243e2aed6e9bf887c3efc3e25 /src/libstd
parentb365de94df941ae1bace2744620e453972560cdf (diff)
parentaa4f73c845f29188acf51a42db7d3d86b827cb6f (diff)
downloadrust-3c9e884dd3bf93b1516d3b5858072b7659c4cfba.tar.gz
rust-3c9e884dd3bf93b1516d3b5858072b7659c4cfba.zip
Rollup merge of #54046 - snaedis:issue-48022, r=steveklabnik
Update documentation for fill_buf in std::io::BufRead

Brings the documentation in line with the BufReader implementation.

Fixes #48022.

This is my first PR, and I think the `E-easy` label is very cool, as so is the practice of describing the fix but leaving it for someone else; it really makes it a lot less intimidating to get started with something!
Diffstat (limited to 'src/libstd')
-rw-r--r--src/libstd/io/mod.rs3
1 files changed, 2 insertions, 1 deletions
diff --git a/src/libstd/io/mod.rs b/src/libstd/io/mod.rs
index b83f3fbe7a5..278ee7951b3 100644
--- a/src/libstd/io/mod.rs
+++ b/src/libstd/io/mod.rs
@@ -1330,7 +1330,8 @@ fn read_until<R: BufRead + ?Sized>(r: &mut R, delim: u8, buf: &mut Vec<u8>)
 ///
 #[stable(feature = "rust1", since = "1.0.0")]
 pub trait BufRead: Read {
-    /// Fills the internal buffer of this object, returning the buffer contents.
+    /// Returns the contents of the internal buffer, filling it with more data
+    /// from the inner reader if it is empty.
     ///
     /// This function is a lower-level call. It needs to be paired with the
     /// [`consume`] method to function properly. When calling this