Rollup merge of rust-lang#52718 - fintelia:patch-2, r=cramertj

State default capacity for BufReader/BufWriter Addresses rust-lang#52513
Mark-Simulacrum · Jul 26, 2018 · 091a10e · 091a10e
2 parents cc7a826 + abb704e
commit 091a10e
Showing 1 changed file with 4 additions and 2 deletions.
diff --git a/src/libstd/io/buffered.rs b/src/libstd/io/buffered.rs
@@ -61,7 +61,8 @@ pub struct BufReader<R> {
 }
 
 impl<R: Read> BufReader<R> {
-    /// Creates a new `BufReader` with a default buffer capacity.
+    /// Creates a new `BufReader` with a default buffer capacity. The default is currently 8 KB,
+    /// but may change in the future.
     ///
     /// # Examples
     ///
@@ -454,7 +455,8 @@ pub struct BufWriter<W: Write> {
 pub struct IntoInnerError<W>(W, Error);
 
 impl<W: Write> BufWriter<W> {
-    /// Creates a new `BufWriter` with a default buffer capacity.
+    /// Creates a new `BufWriter` with a default buffer capacity. The default is currently 8 KB,
+    /// but may change in the future.
     ///
     /// # Examples
     ///