Fix some documentation issues.
This commit is contained in:
parent
e8d39ae9e4
commit
7a882dd581
|
@ -2,6 +2,9 @@
|
||||||
#![cfg_attr(all(feature = "use_alloc", not(feature = "use_std")), feature(alloc))]
|
#![cfg_attr(all(feature = "use_alloc", not(feature = "use_std")), feature(alloc))]
|
||||||
#![cfg_attr(all(feature = "use_collections", not(feature = "use_std")), feature(collections))]
|
#![cfg_attr(all(feature = "use_collections", not(feature = "use_std")), feature(collections))]
|
||||||
|
|
||||||
|
//! A library that provides a way to logically own objects, whether or not
|
||||||
|
//! heap allocation is available.
|
||||||
|
|
||||||
#[cfg(feature = "use_std")]
|
#[cfg(feature = "use_std")]
|
||||||
extern crate std;
|
extern crate std;
|
||||||
#[cfg(all(feature = "use_alloc", not(feature = "use_std")))]
|
#[cfg(all(feature = "use_alloc", not(feature = "use_std")))]
|
||||||
|
|
|
@ -27,7 +27,7 @@ use collections::vec::Vec;
|
||||||
///
|
///
|
||||||
/// Note that a `Vec<T>` converted into an `Into<Managed<'static, [T]>>` gets transformed
|
/// Note that a `Vec<T>` converted into an `Into<Managed<'static, [T]>>` gets transformed
|
||||||
/// into a boxed slice, and can no longer be resized. See also
|
/// into a boxed slice, and can no longer be resized. See also
|
||||||
/// [ManagedSlice][struct.ManagedSlice.html], which does not have this drawback.
|
/// [ManagedSlice](enum.ManagedSlice.html), which does not have this drawback.
|
||||||
pub enum Managed<'a, T: 'a + ?Sized> {
|
pub enum Managed<'a, T: 'a + ?Sized> {
|
||||||
/// Borrowed variant.
|
/// Borrowed variant.
|
||||||
Borrowed(&'a mut T),
|
Borrowed(&'a mut T),
|
||||||
|
|
|
@ -21,7 +21,7 @@ use collections::vec::Vec;
|
||||||
/// argument; then, it will be possible to pass either a `Vec<T>`, or a `&'a mut [T]`
|
/// argument; then, it will be possible to pass either a `Vec<T>`, or a `&'a mut [T]`
|
||||||
/// without any conversion at the call site.
|
/// without any conversion at the call site.
|
||||||
///
|
///
|
||||||
/// See also [Managed][struct.Managed.html].
|
/// See also [Managed](enum.Managed.html).
|
||||||
pub enum ManagedSlice<'a, T: 'a> {
|
pub enum ManagedSlice<'a, T: 'a> {
|
||||||
/// Borrowed variant.
|
/// Borrowed variant.
|
||||||
Borrowed(&'a mut [T]),
|
Borrowed(&'a mut [T]),
|
||||||
|
|
Loading…
Reference in New Issue