document the nightly feature

This commit is contained in:
Jorge Aparicio 2019-02-15 20:20:38 +01:00
parent c8df71adf0
commit 16821c8315

View file

@ -35,6 +35,11 @@
//! //!
//! [`Instant`]: struct.Instant.html //! [`Instant`]: struct.Instant.html
//! [`Duration`]: struct.Duration.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))] #![cfg_attr(feature = "nightly", feature(maybe_uninit))]
#![deny(missing_docs)] #![deny(missing_docs)]