docs: Add indicators for methods that are std-only (#53)

* docs: Add std-only indications * Module-level doc * fmt
smol-rs · Mar 4, 2023 · f939572 · f939572
1 parent c1cbe9b
commit f939572
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/Cargo.toml b/Cargo.toml
@@ -30,3 +30,7 @@ getrandom = { version = "0.2", features = ["js"] }
 rand = "0.8"
 wyhash = "0.5"
 getrandom = "0.2"
+
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]
diff --git a/src/lib.rs b/src/lib.rs
@@ -72,13 +72,15 @@
 //!   the [`with_seed`](Rng::with_seed) method.
 
 #![cfg_attr(not(feature = "std"), no_std)]
+#![cfg_attr(docsrs, feature(doc_cfg))]
 #![forbid(unsafe_code)]
 #![warn(missing_docs, missing_debug_implementations, rust_2018_idioms)]
 
 use core::convert::{TryFrom, TryInto};
 use core::ops::{Bound, RangeBounds};
 
 #[cfg(feature = "std")]
+#[cfg_attr(docsrs, doc(cfg(feature = "std")))]
 mod global_rng;
 
 #[cfg(feature = "std")]