about summary refs log tree commit diff
path: root/src/libcore
diff options
context:
space:
mode:
authorbors <bors@rust-lang.org>2014-05-17 23:41:28 -0700
committerbors <bors@rust-lang.org>2014-05-17 23:41:28 -0700
commita62395f01ca4f2db1b9004aa4f54422956950304 (patch)
tree1a58e7bf85f38c819b1d2bb27519dc400a83cbed /src/libcore
parent134f797a6309e8f284372c745689bcde17829c30 (diff)
parent0989f5c2e7b5ddd98cfc98300366278b9445de73 (diff)
auto merge of #14249 : alexcrichton/rust/issue-14246, r=huonw
Closes #14246
Diffstat (limited to 'src/libcore')
-rw-r--r--src/libcore/prelude.rs18
1 files changed, 17 insertions, 1 deletions
diff --git a/src/libcore/prelude.rs b/src/libcore/prelude.rs
index 2c6b0af8d94..a8e78e52b12 100644
--- a/src/libcore/prelude.rs
+++ b/src/libcore/prelude.rs
@@ -10,7 +10,23 @@
 
 //! The core prelude
 //!
-//! For more information, see std::prelude.
+//! This module is intended for users of libcore which do not link to libstd as
+//! well. This module is not imported by default, but using the entire contents
+//! of this module will provide all of the useful traits and types in libcore
+//! that one would expect from the standard library as well.
+//!
+//! There is no method to automatically inject this prelude, and this prelude is
+//! a subset of the standard library's prelude.
+//!
+//! # Example
+//!
+//! ```ignore
+//! # fn main() {
+//! #![feature(globs)]
+//!
+//! use core::prelude::*;
+//! # }
+//! ```
 
 // Reexported core operators
 pub use kinds::{Copy, Send, Sized, Share};