about summary refs log tree commit diff
path: root/src/liballoc
diff options
context:
space:
mode:
authorAriel Ben-Yehuda <arielb1@mail.tau.ac.il>2017-06-29 08:40:03 +0000
committerGitHub <noreply@github.com>2017-06-29 08:40:03 +0000
commit5682494cf8adbb1bd99e4fc135d5f960bedcf27b (patch)
tree70c6a3e931130fd8b768b55c730c628f29cde47e /src/liballoc
parent8b32c511e7e8689c8f49f81589ccc1a734c02e84 (diff)
parentc5d078fd8cf554aa1ee6e6b3a0d670ca9afa4054 (diff)
downloadrust-5682494cf8adbb1bd99e4fc135d5f960bedcf27b.tar.gz
rust-5682494cf8adbb1bd99e4fc135d5f960bedcf27b.zip
Rollup merge of #42832 - rthomas:doc-fmt, r=steveklabnik
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 1bd95fb82aa..4847b21c0b3 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
 ///