Skip to content

Commit

Permalink
auto merge of #6907 : steveklabnik/rust/prelude_docs, r=graydon
Browse files Browse the repository at this point in the history
  • Loading branch information
bors committed Jun 3, 2013
2 parents 8a43b31 + fe70361 commit 846545a
Showing 1 changed file with 18 additions and 1 deletion.
19 changes: 18 additions & 1 deletion src/libstd/prelude.rs
Expand Up @@ -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};
Expand Down

0 comments on commit 846545a

Please sign in to comment.