From 20633740dbdd87748f4e1c8fed1324bb3395906f Mon Sep 17 00:00:00 2001 From: Caio Date: Sun, 16 Jun 2019 07:50:44 -0300 Subject: [PATCH] Adjust documentation --- src/lib.rs | 10 +++------- 1 file changed, 3 insertions(+), 7 deletions(-) diff --git a/src/lib.rs b/src/lib.rs index 876a2e7..1a011ff 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -8,14 +8,10 @@ //! to the heap for larger allocations. This can be a useful optimization for improving cache //! locality and reducing allocator traffic for workloads that fit within the inline buffer. //! -//! ## no_std support +//! ## `alloc` support //! -//! By default, `smallvec` depends on `libstd`. However, it can be configured to use the unstable -//! `liballoc` API instead, for use on platforms that have `liballoc` but not `libstd`. This -//! configuration is currently unstable and is not guaranteed to work on all versions of Rust. -//! -//! To depend on `smallvec` without `libstd`, use `default-features = false` in the `smallvec` -//! section of Cargo.toml to disable its `"alloc"` feature. +//! By default, `smallvec` uses the `alloc` crate, which means that it can be used on platforms +//! that have `liballoc` but not `libstd`. //! //! ## `union` feature //!