diff options
| author | Alex Crichton <alex@alexcrichton.com> | 2013-09-17 19:42:07 -0700 |
|---|---|---|
| committer | Alex Crichton <alex@alexcrichton.com> | 2013-09-17 20:50:23 -0700 |
| commit | 88bc11e646c8d1db7ac7894f74e2f660d9a82c54 (patch) | |
| tree | e0dfde7157dadefae8bb2420e8e93f9eefc95bfa /src/libstd/fmt | |
| parent | 0efc4822e93221714aa7d142de44a057bdbad2ca (diff) | |
| download | rust-88bc11e646c8d1db7ac7894f74e2f660d9a82c54.tar.gz rust-88bc11e646c8d1db7ac7894f74e2f660d9a82c54.zip | |
Document a few undocumented modules in libstd
Hopefull this will make our libstd docs appear a little more "full".
Diffstat (limited to 'src/libstd/fmt')
| -rw-r--r-- | src/libstd/fmt/mod.rs | 17 |
1 files changed, 9 insertions, 8 deletions
diff --git a/src/libstd/fmt/mod.rs b/src/libstd/fmt/mod.rs index cad9f14bda7..99a5ed4d698 100644 --- a/src/libstd/fmt/mod.rs +++ b/src/libstd/fmt/mod.rs @@ -10,17 +10,18 @@ /*! -# The Formatting Module +The Formatting Module -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. +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. The functions contained in this module should not normally be used in everyday -use cases of `format!`. The assumptions made by these functions are unsafe for all -inputs, and the compiler performs a large amount of validation on the arguments -to `format!` in order to ensure safety at runtime. While it is possible to call -these functions directly, it is not recommended to do so in the general case. +use cases of `format!`. The assumptions made by these functions are unsafe for +all inputs, and the compiler performs a large amount of validation on the +arguments to `format!` in order to ensure safety at runtime. While it is +possible to call these functions directly, it is not recommended to do so in the +general case. ## Usage |
