about summary refs log tree commit diff
path: root/src/libcore
diff options
context:
space:
mode:
authorRyan Thomas <ryan@ryant.org>2017-06-22 19:50:56 +0100
committerRyan Thomas <ryan@ryant.org>2017-06-22 19:50:56 +0100
commitb9a44fc489a55ebdcc04b09067e2ab9164f30810 (patch)
tree87a5b9c135f8cdbaf8ac86266d9a6f89afc62fd6 /src/libcore
parentab5bec25530aac43dfd64384b405c909b6e405e3 (diff)
downloadrust-b9a44fc489a55ebdcc04b09067e2ab9164f30810.tar.gz
rust-b9a44fc489a55ebdcc04b09067e2ab9164f30810.zip
Update docs for fmt::write.
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
Diffstat (limited to 'src/libcore')
-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
 ///