about summary refs log tree commit diff
diff options
context:
space:
mode:
authorAriel Ben-Yehuda <arielb1@mail.tau.ac.il>2017-06-29 08:40:02 +0000
committerGitHub <noreply@github.com>2017-06-29 08:40:02 +0000
commit8b32c511e7e8689c8f49f81589ccc1a734c02e84 (patch)
tree173311d333038d19b2d112025e70b2fe56e1ba96
parentbea4e60327d36d6f42034f51a4d3d9ac3f391363 (diff)
parentb9a44fc489a55ebdcc04b09067e2ab9164f30810 (diff)
downloadrust-8b32c511e7e8689c8f49f81589ccc1a734c02e84.tar.gz
rust-8b32c511e7e8689c8f49f81589ccc1a734c02e84.zip
Rollup merge of #42831 - rthomas:master, r=QuietMisdreavus
Update docs for fmt::write.

#29355

I reworded it slightly to make it more clear that the function only take
two arguments - the output and the Arguments struct that can be
generated from the format_args! macro.

r? @steveklabnik
-rw-r--r--src/libcore/fmt/mod.rs11
1 files changed, 4 insertions, 7 deletions
diff --git a/src/libcore/fmt/mod.rs b/src/libcore/fmt/mod.rs
index 8c3d3ce7d88..bcc6d53c81d 100644
--- a/src/libcore/fmt/mod.rs
+++ b/src/libcore/fmt/mod.rs
@@ -897,14 +897,11 @@ pub trait UpperExp {
     fn fmt(&self, f: &mut Formatter) -> Result;
 }
 
-/// The `write` function takes an output stream, a precompiled format string,
-/// and a list of arguments. The arguments will be formatted according to the
-/// specified format string into the output stream provided.
+/// The `write` function takes an output stream, and an `Arguments` struct
+/// that can be precompiled with the `format_args!` macro.
 ///
-/// # Arguments
-///
-///   * output - the buffer to write output to
-///   * args - the precompiled arguments generated by `format_args!`
+/// The arguments will be formatted according to the specified format string
+/// into the output stream provided.
 ///
 /// # Examples
 ///