diff options
| author | P1start <rewi-github@whanau.org> | 2014-08-04 22:48:39 +1200 |
|---|---|---|
| committer | P1start <rewi-github@whanau.org> | 2014-08-19 17:22:18 +1200 |
| commit | f2aa88ca0676249d9c44bb6a2e59cd2b1cdd9c9a (patch) | |
| tree | 50acf564d76caea6531e76609eb44df7671eed70 /src/liballoc/lib.rs | |
| parent | eaf810a219b136fff67e75840ad3c5efde9ae1e5 (diff) | |
| download | rust-f2aa88ca0676249d9c44bb6a2e59cd2b1cdd9c9a.tar.gz rust-f2aa88ca0676249d9c44bb6a2e59cd2b1cdd9c9a.zip | |
A few minor documentation fixes
Diffstat (limited to 'src/liballoc/lib.rs')
| -rw-r--r-- | src/liballoc/lib.rs | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/src/liballoc/lib.rs b/src/liballoc/lib.rs index 7809c17d938..cacb9e28989 100644 --- a/src/liballoc/lib.rs +++ b/src/liballoc/lib.rs @@ -8,7 +8,7 @@ // option. This file may not be copied, modified, or distributed // except according to those terms. -//! Rust's core allocation library +//! # The Rust core allocation library //! //! This is the lowest level library through which allocation in Rust can be //! performed where the allocation is assumed to succeed. This library will @@ -23,13 +23,13 @@ //! //! ## Boxed values //! -//! The [`Box`](boxed/index.html) type is the core owned pointer type in rust. +//! The [`Box`](boxed/index.html) type is the core owned pointer type in Rust. //! There can only be one owner of a `Box`, and the owner can decide to mutate //! the contents, which live on the heap. //! //! This type can be sent among tasks efficiently as the size of a `Box` value -//! is just a pointer. Tree-like data structures are often built on owned -//! pointers because each node often has only one owner, the parent. +//! is the same as that of a pointer. Tree-like data structures are often built +//! with boxes because each node often has only one owner, the parent. //! //! ## Reference counted pointers //! @@ -37,8 +37,8 @@ //! type intended for sharing memory within a task. An `Rc` pointer wraps a //! type, `T`, and only allows access to `&T`, a shared reference. //! -//! This type is useful when inherited mutability is too constraining for an -//! application (such as using `Box`), and is often paired with the `Cell` or +//! This type is useful when inherited mutability (such as using `Box`) is too +//! constraining for an application, and is often paired with the `Cell` or //! `RefCell` types in order to allow mutation. //! //! ## Atomically reference counted pointers |
