From 369b99ee3f233e96f1b01780e420c8d4d7e7b383 Mon Sep 17 00:00:00 2001 From: Jack Grigg Date: Fri, 17 Dec 2021 22:08:58 +0000 Subject: [PATCH] Add `doc_cfg` annotations --- Cargo.toml | 3 ++- src/address.rs | 1 + src/builder.rs | 1 + src/bundle.rs | 1 + src/keys.rs | 1 + src/note.rs | 1 + src/note/nullifier.rs | 1 + src/primitives/redpallas.rs | 1 + src/tree.rs | 2 ++ src/value.rs | 1 + 10 files changed, 12 insertions(+), 1 deletion(-) diff --git a/Cargo.toml b/Cargo.toml index d68659bb..5de696ed 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -16,7 +16,8 @@ readme = "README.md" publish = false [package.metadata.docs.rs] -rustdoc-args = [ "--html-in-header", "katex-header.html" ] +all-features = true +rustdoc-args = ["--cfg", "docsrs", "--html-in-header", "katex-header.html"] [dependencies] aes = "0.7" diff --git a/src/address.rs b/src/address.rs index 0f61ed26..560e3942 100644 --- a/src/address.rs +++ b/src/address.rs @@ -67,6 +67,7 @@ impl Address { /// Generators for property testing. #[cfg(any(test, feature = "test-dependencies"))] +#[cfg_attr(docsrs, doc(cfg(feature = "test-dependencies")))] pub mod testing { use proptest::prelude::*; diff --git a/src/builder.rs b/src/builder.rs index df397309..37a2768c 100644 --- a/src/builder.rs +++ b/src/builder.rs @@ -568,6 +568,7 @@ impl Bundle, V> { /// Generators for property testing. #[cfg(any(test, feature = "test-dependencies"))] +#[cfg_attr(docsrs, doc(cfg(feature = "test-dependencies")))] pub mod testing { use incrementalmerkletree::{bridgetree::BridgeTree, Frontier, Tree}; diff --git a/src/bundle.rs b/src/bundle.rs index d095e8da..550b42ca 100644 --- a/src/bundle.rs +++ b/src/bundle.rs @@ -506,6 +506,7 @@ pub struct BundleAuthorizingCommitment(pub Blake2bHash); /// Generators for property testing. #[cfg(any(test, feature = "test-dependencies"))] +#[cfg_attr(docsrs, doc(cfg(feature = "test-dependencies")))] pub mod testing { use nonempty::NonEmpty; use pasta_curves::{arithmetic::FieldExt, pallas}; diff --git a/src/keys.rs b/src/keys.rs index e8bd210a..e317f0ca 100644 --- a/src/keys.rs +++ b/src/keys.rs @@ -792,6 +792,7 @@ impl SharedSecret { /// Generators for property testing. #[cfg(any(test, feature = "test-dependencies"))] +#[cfg_attr(docsrs, doc(cfg(feature = "test-dependencies")))] pub mod testing { use proptest::prelude::*; diff --git a/src/note.rs b/src/note.rs index 199971d2..de318194 100644 --- a/src/note.rs +++ b/src/note.rs @@ -249,6 +249,7 @@ pub struct TransmittedNoteCiphertext { /// Generators for property testing. #[cfg(any(test, feature = "test-dependencies"))] +#[cfg_attr(docsrs, doc(cfg(feature = "test-dependencies")))] pub mod testing { use proptest::prelude::*; diff --git a/src/note/nullifier.rs b/src/note/nullifier.rs index 6090f335..a0ede6fb 100644 --- a/src/note/nullifier.rs +++ b/src/note/nullifier.rs @@ -60,6 +60,7 @@ impl Nullifier { /// Generators for property testing. #[cfg(any(test, feature = "test-dependencies"))] +#[cfg_attr(docsrs, doc(cfg(feature = "test-dependencies")))] pub mod testing { use group::Group; use pasta_curves::{arithmetic::FieldExt, pallas}; diff --git a/src/primitives/redpallas.rs b/src/primitives/redpallas.rs index 38de97f9..7314dfdd 100644 --- a/src/primitives/redpallas.rs +++ b/src/primitives/redpallas.rs @@ -175,6 +175,7 @@ pub(crate) mod private { /// Generators for property testing. #[cfg(any(test, feature = "test-dependencies"))] +#[cfg_attr(docsrs, doc(cfg(feature = "test-dependencies")))] pub mod testing { use std::convert::TryFrom; diff --git a/src/tree.rs b/src/tree.rs index d3101e73..c3b3f08b 100644 --- a/src/tree.rs +++ b/src/tree.rs @@ -81,6 +81,7 @@ pub struct MerklePath { } #[cfg(any(test, feature = "test-dependencies"))] +#[cfg_attr(docsrs, doc(cfg(feature = "test-dependencies")))] impl From<(incrementalmerkletree::Position, Vec)> for MerklePath { fn from(path: (incrementalmerkletree::Position, Vec)) -> Self { use std::convert::TryInto; @@ -265,6 +266,7 @@ impl<'de> Deserialize<'de> for MerkleHashOrchard { /// Generators for property testing. #[cfg(any(test, feature = "test-dependencies"))] +#[cfg_attr(docsrs, doc(cfg(feature = "test-dependencies")))] pub mod testing { #[cfg(test)] use incrementalmerkletree::{ diff --git a/src/value.rs b/src/value.rs index 7152643d..9bdecfc3 100644 --- a/src/value.rs +++ b/src/value.rs @@ -296,6 +296,7 @@ impl ValueCommitment { /// Generators for property testing. #[cfg(any(test, feature = "test-dependencies"))] +#[cfg_attr(docsrs, doc(cfg(feature = "test-dependencies")))] pub mod testing { use pasta_curves::{arithmetic::FieldExt, pallas}; use proptest::prelude::*;