Use doc(cfg) to annotate feature-gated items

rust-random · Aug 19, 2020 · 73c15f9 · 73c15f9
1 parent 836686a
commit 73c15f9
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git a/rand_core/src/lib.rs b/rand_core/src/lib.rs
@@ -37,7 +37,7 @@
 #![doc(test(attr(allow(unused_variables), deny(warnings))))]
 #![allow(clippy::unreadable_literal)]
 #![cfg_attr(not(feature = "std"), no_std)]
-
+#![cfg_attr(nightly, feature(doc_cfg))]
 
 use core::convert::AsMut;
 use core::default::Default;
@@ -364,6 +364,7 @@ pub trait SeedableRng: Sized {
     ///
     /// [`getrandom`]: https://docs.rs/getrandom
     #[cfg(feature = "getrandom")]
+    #[cfg_attr(nightly, doc(cfg(feature = "getrandom")))]
     fn from_entropy() -> Self {
         let mut seed = Self::Seed::default();
         if let Err(err) = getrandom::getrandom(seed.as_mut()) {

diff --git a/rand_core/src/os.rs b/rand_core/src/os.rs
@@ -43,6 +43,7 @@ use getrandom::getrandom;
 /// ```
 ///
 /// [getrandom]: https://crates.io/crates/getrandom
+#[cfg_attr(nightly, doc(cfg(feature = "getrandom")))]
 #[derive(Clone, Copy, Debug, Default)]
 pub struct OsRng;