Use single quotes, and doc the Rc struct itself.

This commit is contained in:
Ulysse Carion 2017-06-05 12:07:54 -07:00
parent 8d9df99fbb
commit 1af0cb1650
2 changed files with 6 additions and 5 deletions

View File

@ -42,8 +42,8 @@ use heap::deallocate;
/// necessarily) at _exactly_ `MAX_REFCOUNT + 1` references.
const MAX_REFCOUNT: usize = (isize::MAX) as usize;
/// A thread-safe reference-counting pointer. "Arc" stands for "Atomically
/// Reference Counted".
/// A thread-safe reference-counting pointer. 'Arc' stands for 'Atomically
/// Reference Counted'.
///
/// The type `Arc<T>` provides shared ownership of a value of type `T`,
/// allocated in the heap. Invoking [`clone`][clone] on `Arc` produces

View File

@ -10,8 +10,8 @@
#![allow(deprecated)]
//! Single-threaded reference-counting pointers. "Rc" stands for "Reference
//! Counted".
//! Single-threaded reference-counting pointers. 'Rc' stands for 'Reference
//! Counted'.
//!
//! The type [`Rc<T>`][`Rc`] provides shared ownership of a value of type `T`,
//! allocated in the heap. Invoking [`clone`][clone] on [`Rc`] produces a new
@ -267,7 +267,8 @@ struct RcBox<T: ?Sized> {
value: T,
}
/// A single-threaded reference-counting pointer.
/// A single-threaded reference-counting pointer. 'Rc' stands for 'Reference
/// Counted'.
///
/// See the [module-level documentation](./index.html) for more details.
///