Skip to content

Commit 5c34892

Browse files
committed
doc: format! may or may not handle streams in future
No need to talk about that here
1 parent e88defe commit 5c34892

File tree

1 file changed

+3
-6
lines changed

1 file changed

+3
-6
lines changed

src/libcollections/fmt.rs

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,19 +8,16 @@
88
// option. This file may not be copied, modified, or distributed
99
// except according to those terms.
1010

11-
//! Utilities for formatting and printing strings
11+
//! Utilities for formatting and printing `String`s
1212
//!
1313
//! This module contains the runtime support for the `format!` syntax extension.
1414
//! This macro is implemented in the compiler to emit calls to this module in
15-
//! order to format arguments at runtime into strings and streams.
15+
//! order to format arguments at runtime into strings.
1616
//!
1717
//! # Usage
1818
//!
1919
//! The `format!` macro is intended to be familiar to those coming from C's
20-
//! printf/fprintf functions or Python's `str.format` function. In its current
21-
//! revision, the `format!` macro returns a `String` type which is the result of
22-
//! the formatting. In the future it will also be able to pass in a stream to
23-
//! format arguments directly while performing minimal allocations.
20+
//! printf/fprintf functions or Python's `str.format` function.
2421
//!
2522
//! Some examples of the `format!` extension are:
2623
//!

0 commit comments

Comments
 (0)