From 0989f5c2e7b5ddd98cfc98300366278b9445de73 Mon Sep 17 00:00:00 2001 From: Alex Crichton Date: Fri, 16 May 2014 13:22:08 -0700 Subject: [PATCH] core: Clarify the documentation on core's prelude Closes #14246 --- src/libcore/prelude.rs | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/src/libcore/prelude.rs b/src/libcore/prelude.rs index 2c6b0af8d94e6..a8e78e52b12f8 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};