diff options
| author | Tshepang Lekhonkhobe <tshepang@gmail.com> | 2016-05-12 23:47:14 +0200 |
|---|---|---|
| committer | Tshepang Lekhonkhobe <tshepang@gmail.com> | 2016-05-14 13:28:56 +0200 |
| commit | 5c3489204cde1baca36e0af89d9703607036fd8f (patch) | |
| tree | 9a922ce06cd470f9fd6626ec6529250b680d87a4 | |
| parent | e88defe71806ad190588e168e513bc1098f7c9fb (diff) | |
| download | rust-5c3489204cde1baca36e0af89d9703607036fd8f.tar.gz rust-5c3489204cde1baca36e0af89d9703607036fd8f.zip | |
doc: format! may or may not handle streams in future
No need to talk about that here
| -rw-r--r-- | src/libcollections/fmt.rs | 9 |
1 files changed, 3 insertions, 6 deletions
diff --git a/src/libcollections/fmt.rs b/src/libcollections/fmt.rs index ce1d6ec5a64..ba71b408389 100644 --- a/src/libcollections/fmt.rs +++ b/src/libcollections/fmt.rs @@ -8,19 +8,16 @@ // option. This file may not be copied, modified, or distributed // except according to those terms. -//! Utilities for formatting and printing strings +//! Utilities for formatting and printing `String`s //! //! This module contains the runtime support for the `format!` syntax extension. //! This macro is implemented in the compiler to emit calls to this module in -//! order to format arguments at runtime into strings and streams. +//! order to format arguments at runtime into strings. //! //! # Usage //! //! The `format!` macro is intended to be familiar to those coming from C's -//! printf/fprintf functions or Python's `str.format` function. In its current -//! revision, the `format!` macro returns a `String` type which is the result of -//! the formatting. In the future it will also be able to pass in a stream to -//! format arguments directly while performing minimal allocations. +//! printf/fprintf functions or Python's `str.format` function. //! //! Some examples of the `format!` extension are: //! |
