Skip to content

Commit 4e2d8d8

Browse files
committed
core: Add crate docs
1 parent cd9b344 commit 4e2d8d8

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

src/libcore/core.rc

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,22 @@
77
#[license = "MIT"];
88
#[crate_type = "lib"];
99

10+
#[doc(
11+
brief = "The Rust core library",
12+
desc =
13+
"The core library provides functionality that is closely tied to \
14+
the Rust built-in types and runtime services, or that is used in nearly \
15+
every non-trivial program.\
16+
\
17+
The core library is linked by default to all crates and the contents \
18+
imported. The effect is as though the user had written the following: \
19+
\
20+
> use core; \
21+
> import core::*; \
22+
\
23+
This behavior can be disabled with the `--no-core` compiler flag."
24+
)];
25+
1026
export box, char, float, bessel, f32, f64, int, str, ptr;
1127
export uint, u8, u32, u64, vec, bool;
1228
export either, option, result;

0 commit comments

Comments
 (0)