From ef0dae241aa0bb5cc008ede85568184640720bf9 Mon Sep 17 00:00:00 2001 From: Henry de Valence Date: Tue, 27 Mar 2018 14:24:06 -0700 Subject: [PATCH] Add an explanatory note that's built on stable When building on stable, the README.md is not included in the documentation, leaving a bare entry. This adds a warning stub, pointing people to use nightly rust. --- src/lib.rs | 3 +++ 1 file changed, 3 insertions(+) diff --git a/src/lib.rs b/src/lib.rs index 0a8a1a3..6699118 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -26,6 +26,9 @@ #![cfg_attr(feature = "nightly", doc(include = "../README.md"))] #![doc(html_logo_url = "https://doc.dalek.rs/assets/dalek-logo-clear.png")] +//! Note that docs will only build on nightly Rust until +//! [RFC 1990 stabilizes](https://github.com/rust-lang/rust/issues/44732). + //------------------------------------------------------------------------ // External dependencies: //------------------------------------------------------------------------