]> git.lizzy.rs Git - rust.git/commitdiff
Refine read_to_end documentation
authorSimonas Kazlauskas <git@kazlauskas.me>
Mon, 13 Apr 2015 19:21:51 +0000 (22:21 +0300)
committerSimonas Kazlauskas <git@kazlauskas.me>
Mon, 13 Apr 2015 19:41:41 +0000 (22:41 +0300)
src/libstd/io/mod.rs

index f0f37117ed3bebe582e79f541461c6fb5ee850fd..fa641446e17acea81e05b7301e5b6bfaf06459d2 100644 (file)
@@ -172,14 +172,11 @@ pub trait Read {
     /// Read all bytes until EOF in this source, placing them into `buf`.
     ///
     /// All bytes read from this source will be appended to the specified buffer
-    /// `buf`. This function will return a call to `read` either:
+    /// `buf`. This function will continuously call `read` to append more data to
+    /// `buf` until `read` returns either `Ok(0)` or an error of
+    /// non-`ErrorKind::Interrupted` kind.
     ///
-    /// 1. Returns `Ok(0)`.
-    /// 2. Returns an error which is not of the kind `ErrorKind::Interrupted`.
-    ///
-    /// Until one of these conditions is met the function will continuously
-    /// invoke `read` to append more data to `buf`. If successful, this function
-    /// will return the total number of bytes read.
+    /// If successful, this function will return the total number of bytes read.
     ///
     /// # Errors
     ///