Skip to content

Commit

Permalink
Update docs for std::fmt::format rust-lang#29355.
Browse files Browse the repository at this point in the history
This rewords and removes the `Arguments` section from the docs for
fmt::format.

r? @steveklabnik
  • Loading branch information
rthomas committed Jun 22, 2017
1 parent ab5bec2 commit c5d078f
Showing 1 changed file with 3 additions and 5 deletions.
8 changes: 3 additions & 5 deletions src/liballoc/fmt.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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
///
Expand Down

0 comments on commit c5d078f

Please sign in to comment.