From bb368799c3f955421c968caf4f1ce3e0739d2c9a Mon Sep 17 00:00:00 2001
From: Thom Chiovoloni <thom@shift.click>
Date: Thu, 5 Sep 2024 18:57:56 -0700
Subject: [PATCH] Improve documentation of features. (#272)

* Improve documentation of nightly features

* Document undocumented features
---
 Cargo.toml | 11 ++++++++++-
 1 file changed, 10 insertions(+), 1 deletion(-)

diff --git a/Cargo.toml b/Cargo.toml
index c6577db..2362266 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -13,10 +13,16 @@ exclude = ["/pedantic.bat"]
 
 [features]
 # In v2 we'll fix these names to be more "normal".
+
+# Enable deriving the various `bytemuck` traits.
 derive = ["bytemuck_derive"]
+# Enable features requiring items from `extern crate alloc`.
 extern_crate_alloc = []
+# Enable features requiring items from `extern crate std`.
 extern_crate_std = ["extern_crate_alloc"]
+# Implement `Zeroable` for `MaybeUninit`.
 zeroable_maybe_uninit = []
+# Implement `Zeroable` for `std::sync::atomic` types.
 zeroable_atomics = []
 
 # All MSRV notes below are GUIDELINES and future versions may require even more
@@ -56,8 +62,11 @@ latest_stable_rust = [
   "zeroable_maybe_uninit",
 ]
 
-# NOT SEMVER SUPPORTED! TEMPORARY ONLY!
+# ALL FEATURES BELOW THIS ARE NOT SEMVER SUPPORTED! TEMPORARY ONLY!
+
+# Enable support for `std::simd` types.
 nightly_portable_simd = []
+# Enable support for unstable `std::arch` types (such as the AVX512 types).
 nightly_stdsimd = []
 # Enable `f16` and `f128`
 nightly_float = []