Improve documentation of features. (#272)

* Improve documentation of nightly features

* Document undocumented features
This commit is contained in:
Thom Chiovoloni 2024-09-05 18:57:56 -07:00 committed by GitHub
parent 860c391345
commit bb368799c3
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -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 = []