about summary refs log tree commit diff
path: root/src/liballoc
diff options
context:
space:
mode:
authorRyan Thomas <ryan@ryant.org>2017-06-22 20:02:57 +0100
committerRyan Thomas <ryan@ryant.org>2017-06-22 20:08:38 +0100
commitc5d078fd8cf554aa1ee6e6b3a0d670ca9afa4054 (patch)
treec4d7e1f98c4f5dbb2edab3b2925bc6c499e1457b /src/liballoc
parentab5bec25530aac43dfd64384b405c909b6e405e3 (diff)
downloadrust-c5d078fd8cf554aa1ee6e6b3a0d670ca9afa4054.tar.gz
rust-c5d078fd8cf554aa1ee6e6b3a0d670ca9afa4054.zip
Update docs for std::fmt::format #29355.
This rewords and removes the `Arguments` section from the docs for
fmt::format.

r? @steveklabnik
Diffstat (limited to 'src/liballoc')
-rw-r--r--src/liballoc/fmt.rs8
1 files changed, 3 insertions, 5 deletions
diff --git a/src/liballoc/fmt.rs b/src/liballoc/fmt.rs
index 62a88164621..3afce884b11 100644
--- a/src/liballoc/fmt.rs
+++ b/src/liballoc/fmt.rs
@@ -498,12 +498,10 @@ pub use core::fmt::{DebugList, DebugMap, DebugSet, DebugStruct, DebugTuple};
 
 use string;
 
-/// The format function takes a precompiled format string and a list of
-/// arguments, to return the resulting formatted string.
+/// The `format` function takes an `Arguments` struct and returns the resulting
+/// formatted string.
 ///
-/// # Arguments
-///
-///   * args - a structure of arguments generated via the `format_args!` macro.
+/// The `Arguments` instance can be created with the `format_args!` macro.
 ///
 /// # Examples
 ///