doc/features.md → mod _features

MaulingMonkey · Jan 26, 2024 · 31b0fb3 · 31b0fb3
1 parent 3a34ce3
commit 31b0fb3
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/doc/features.md b/doc/features.md
@@ -1,4 +1,5 @@
-## Features
+Cargo features of the [`ialloc`](crate) crate.
+
 | Feature               | Description                                   | Additional Requirements |
 | ----------------------| ----------------------------------------------| ------------------------|
 |                       | **API Design**

diff --git a/src/_ialloc.rs b/src/_ialloc.rs
@@ -1,6 +1,5 @@
 #![cfg_attr(allocator_api = "unstable", feature(allocator_api))]
 #![doc = include_str!("../Readme.md")]
-#![doc = include_str!("../doc/features.md")]
 #![no_std]
 
 #![forbid(unreachable_patterns)] // often indicates e.g. a typoed "constant" in a match statement
@@ -30,6 +29,8 @@ mod align {
 }
 
 #[cfg(doc)] #[doc = include_str!("../doc/assumptions.md")] pub mod _assumptions {}
+#[cfg(doc)] #[doc = include_str!("../doc/features.md")] pub mod _features {}
+
 #[path = "allocator/_allocator.rs"      ] pub mod allocator;
 #[path = "boxed/_boxed.rs"              ] pub mod boxed;
 #[path = "traits/_traits.rs"            ] pub mod traits; #[doc(hidden)] pub use traits::*;