From 9ea604addb102e72fd5a0baf4b8f287d52d956fb Mon Sep 17 00:00:00 2001 From: Gauthier Segay Date: Fri, 15 Oct 2021 21:45:16 +0200 Subject: [PATCH] minor doc patch to help users adjust their Cargo.toml for usage of the allocation module. (#76) * just pointer to how to set the crate feature helps the Cargo newbies to enable the feature easily while reading the documentation. * Update allocation.rs --- src/allocation.rs | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/src/allocation.rs b/src/allocation.rs index 33f796c..4c3f965 100644 --- a/src/allocation.rs +++ b/src/allocation.rs @@ -3,7 +3,10 @@ //! Stuff to boost things in the `alloc` crate. //! //! * You must enable the `extern_crate_alloc` feature of `bytemuck` or you will -//! not be able to use this module! +//! not be able to use this module! This is generally done by adding the +//! feature to the dependency in Cargo.toml like so: +//! `bytemuck = { version = "VERSION_YOU_ARE_USING", features = ["extern_crate_alloc"]}` + use super::*; use alloc::{