Skip to content

Commit 0989f5c

Browse files
committed
core: Clarify the documentation on core's prelude
Closes #14246
1 parent bbd034c commit 0989f5c

File tree

1 file changed

+17
-1
lines changed

1 file changed

+17
-1
lines changed

src/libcore/prelude.rs

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,23 @@
1010

1111
//! The core prelude
1212
//!
13-
//! For more information, see std::prelude.
13+
//! This module is intended for users of libcore which do not link to libstd as
14+
//! well. This module is not imported by default, but using the entire contents
15+
//! of this module will provide all of the useful traits and types in libcore
16+
//! that one would expect from the standard library as well.
17+
//!
18+
//! There is no method to automatically inject this prelude, and this prelude is
19+
//! a subset of the standard library's prelude.
20+
//!
21+
//! # Example
22+
//!
23+
//! ```ignore
24+
//! # fn main() {
25+
//! #![feature(globs)]
26+
//!
27+
//! use core::prelude::*;
28+
//! # }
29+
//! ```
1430
1531
// Reexported core operators
1632
pub use kinds::{Copy, Send, Sized, Share};

0 commit comments

Comments
 (0)