From 16821c8315fc5e0f9bfbc6ddd7ca79cc2b1d5d40 Mon Sep 17 00:00:00 2001
From: Jorge Aparicio <jorge@japaric.io>
Date: Fri, 15 Feb 2019 20:20:38 +0100
Subject: [PATCH] document the nightly feature

---
 src/lib.rs | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/src/lib.rs b/src/lib.rs
index 6c79f6c785..4c2fd9e019 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -35,6 +35,11 @@
 //!
 //! [`Instant`]: struct.Instant.html
 //! [`Duration`]: struct.Duration.html
+//!
+//! - `nightly`. Enabling this opt-in feature makes RTFM internally use the unstable
+//! `core::mem::MaybeUninit` API and unstable `const_fn` language feature to reduce static memory
+//! usage, runtime overhead and initialization overhead. This feature requires a nightly compiler
+//! and may stop working at any time!
 
 #![cfg_attr(feature = "nightly", feature(maybe_uninit))]
 #![deny(missing_docs)]