From b2b377117ab51bde361ff4e988d60026e2b3554c Mon Sep 17 00:00:00 2001 From: bluss Date: Sun, 6 Aug 2017 18:23:17 +0200 Subject: [PATCH] DOC: Update doc for and disclaimers for crate features --- src/lib.rs | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/src/lib.rs b/src/lib.rs index 3098895..65e454e 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -5,13 +5,16 @@ //! //! - `std` //! - Optional, enabled by default -//! - Use libstd +//! - Use libstd; disable to use `no_std` instead. //! //! - `use_union` //! - Optional //! - Requires Rust nightly channel +//! - Experimental: This flag uses nightly so it may break unexpectedly +//! at some point; since it doesn't change API this flag may also change +//! to do nothing in the future. //! - Use the unstable feature untagged unions for the internal implementation, -//! which has reduced space overhead +//! which may have reduced space overhead //! //! ## Rust Version //!