diff options
| author | Steve Klabnik <steve@steveklabnik.com> | 2013-06-02 20:46:12 -0700 |
|---|---|---|
| committer | Steve Klabnik <steve@steveklabnik.com> | 2013-06-03 11:49:06 -0700 |
| commit | fe70361bb6d89a6226d558c64c03d05bba46412b (patch) | |
| tree | 2d4c45127eeb5627e41ad69b608bda8d7c3d024a /src/libstd | |
| parent | c40baf68cb3306f1beaf1d5443bb2433043b7da7 (diff) | |
| download | rust-fe70361bb6d89a6226d558c64c03d05bba46412b.tar.gz rust-fe70361bb6d89a6226d558c64c03d05bba46412b.zip | |
Add better documentation for the Prelude.
Diffstat (limited to 'src/libstd')
| -rw-r--r-- | src/libstd/prelude.rs | 19 |
1 files changed, 18 insertions, 1 deletions
diff --git a/src/libstd/prelude.rs b/src/libstd/prelude.rs index 5a5efa0781a..bd1c87daf13 100644 --- a/src/libstd/prelude.rs +++ b/src/libstd/prelude.rs @@ -8,7 +8,24 @@ // option. This file may not be copied, modified, or distributed // except according to those terms. -//! The Rust prelude. Imported into every module by default. +/*! + +Many programming languages have a 'prelude': a particular subset of the +libraries that come with the language. Every program imports the prelude by +default. + +For example, it would be annoying to add `use io::println;` to every single +program, and the vast majority of Rust programs will wish to print to standard +output. Therefore, it makes sense to import it into every program. + +Rust's prelude has three main parts: + +1. io::print and io::println. +2. Core operators, such as `Add`, `Mul`, and `Not`. +3. Various types and traits, such as `Clone`, `Eq`, and `comm::Chan`. + +*/ + // Reexported core operators pub use either::{Either, Left, Right}; |
