Use doc_auto_cfg (#1116)

Generates `doc_cfg` automatically
iqlusioninc · Mar 28, 2023 · 8de5858 · 8de5858
1 parent 311fc5d
commit 8de5858
Show file tree

Hide file tree

Showing 35 changed files with 7 additions and 83 deletions.
diff --git a/bip32/src/derivation_path.rs b/bip32/src/derivation_path.rs
@@ -11,7 +11,6 @@ use core::{
 const PREFIX: &str = "m";
 
 /// Derivation paths within a hierarchical keyspace.
-#[cfg_attr(docsrs, doc(cfg(feature = "alloc")))]
 #[derive(Clone, Debug, Default, Eq, PartialEq)]
 pub struct DerivationPath {
     path: Vec<ChildNumber>,

diff --git a/bip32/src/error.rs b/bip32/src/error.rs
@@ -46,7 +46,6 @@ impl Display for Error {
 }
 
 #[cfg(feature = "std")]
-#[cfg_attr(docsrs, doc(cfg(feature = "std")))]
 impl std::error::Error for Error {}
 
 impl From<bs58::decode::Error> for Error {
@@ -74,31 +73,27 @@ impl From<hmac::digest::InvalidLength> for Error {
 }
 
 #[cfg(feature = "secp256k1")]
-#[cfg_attr(docsrs, doc(cfg(feature = "secp256k1")))]
 impl From<k256::elliptic_curve::Error> for Error {
     fn from(_: k256::elliptic_curve::Error) -> Error {
         Error::Crypto
     }
 }
 
 #[cfg(feature = "secp256k1")]
-#[cfg_attr(docsrs, doc(cfg(feature = "secp256k1")))]
 impl From<k256::ecdsa::Error> for Error {
     fn from(_: k256::ecdsa::Error) -> Error {
         Error::Crypto
     }
 }
 
 #[cfg(feature = "secp256k1-ffi")]
-#[cfg_attr(docsrs, doc(cfg(feature = "secp256k1-ffi")))]
 impl From<secp256k1_ffi::Error> for Error {
     fn from(_: secp256k1_ffi::Error) -> Error {
         Error::Crypto
     }
 }
 
 #[cfg(feature = "secp256k1-ffi")]
-#[cfg_attr(docsrs, doc(cfg(feature = "secp256k1-ffi")))]
 impl From<secp256k1_ffi::scalar::OutOfRangeError> for Error {
     fn from(_: secp256k1_ffi::scalar::OutOfRangeError) -> Error {
         Error::Crypto

diff --git a/bip32/src/extended_key/private_key.rs b/bip32/src/extended_key/private_key.rs
@@ -26,7 +26,6 @@ const BIP39_DOMAIN_SEPARATOR: [u8; 12] = [
 
 /// Extended private secp256k1 ECDSA signing key.
 #[cfg(feature = "secp256k1")]
-#[cfg_attr(docsrs, doc(cfg(feature = "secp256k1")))]
 pub type XPrv = ExtendedPrivateKey<k256::ecdsa::SigningKey>;
 
 /// Extended private keys derived using BIP32.
@@ -52,7 +51,6 @@ where
 
     /// Derive a child key from the given [`DerivationPath`].
     #[cfg(feature = "alloc")]
-    #[cfg_attr(docsrs, doc(cfg(feature = "alloc")))]
     pub fn derive_from_path<S>(seed: S, path: &DerivationPath) -> Result<Self>
     where
         S: AsRef<[u8]>,
@@ -163,7 +161,6 @@ where
 
     /// Serialize this key as a self-[`Zeroizing`] `String`.
     #[cfg(feature = "alloc")]
-    #[cfg_attr(docsrs, doc(cfg(feature = "alloc")))]
     pub fn to_string(&self, prefix: Prefix) -> Zeroizing<String> {
         Zeroizing::new(self.to_extended_key(prefix).to_string())
     }

diff --git a/bip32/src/extended_key/public_key.rs b/bip32/src/extended_key/public_key.rs
@@ -12,7 +12,6 @@ use alloc::string::{String, ToString};
 
 /// Extended public secp256k1 ECDSA verification key.
 #[cfg(feature = "secp256k1")]
-#[cfg_attr(docsrs, doc(cfg(feature = "secp256k1")))]
 pub type XPub = ExtendedPublicKey<k256::ecdsa::VerifyingKey>;
 
 /// Extended public keys derived using BIP32.
@@ -94,7 +93,6 @@ where
 
     /// Serialize this key as a `String`.
     #[cfg(feature = "alloc")]
-    #[cfg_attr(docsrs, doc(cfg(feature = "alloc")))]
     pub fn to_string(&self, prefix: Prefix) -> String {
         self.to_extended_key(prefix).to_string()
     }

diff --git a/bip32/src/lib.rs b/bip32/src/lib.rs
@@ -1,5 +1,5 @@
 #![no_std]
-#![cfg_attr(docsrs, feature(doc_cfg))]
+#![cfg_attr(docsrs, feature(doc_auto_cfg))]
 #![doc = include_str!("../README.md")]
 #![forbid(unsafe_code)]
 #![warn(
@@ -130,11 +130,9 @@ pub use crate::{
 pub use crate::derivation_path::DerivationPath;
 
 #[cfg(feature = "bip39")]
-#[cfg_attr(docsrs, doc(cfg(feature = "bip39")))]
 pub use crate::mnemonic::{Language, Phrase as Mnemonic, Seed};
 
 #[cfg(feature = "secp256k1")]
-#[cfg_attr(docsrs, doc(cfg(feature = "secp256k1")))]
 pub use {
     crate::extended_key::{private_key::XPrv, public_key::XPub},
     k256 as secp256k1,

diff --git a/bip32/src/mnemonic/phrase.rs b/bip32/src/mnemonic/phrase.rs
@@ -131,7 +131,6 @@ impl Phrase {
 
     /// Convert this mnemonic phrase into the BIP39 seed value.
     #[cfg(feature = "bip39")]
-    #[cfg_attr(docsrs, doc(cfg(feature = "bip39")))]
     pub fn to_seed(&self, password: &str) -> Seed {
         let salt = Zeroizing::new(format!("mnemonic{}", password));
         let mut seed = [0u8; Seed::SIZE];

diff --git a/bip32/src/mnemonic/seed.rs b/bip32/src/mnemonic/seed.rs
@@ -4,7 +4,6 @@ use zeroize::Zeroize;
 
 /// BIP39 seeds.
 // TODO(tarcieri): support for 32-byte seeds
-#[cfg_attr(docsrs, doc(cfg(feature = "bip39")))]
 pub struct Seed(pub(crate) [u8; Seed::SIZE]);
 
 impl Seed {

diff --git a/bip32/src/private_key.rs b/bip32/src/private_key.rs
@@ -29,7 +29,6 @@ pub trait PrivateKey: Sized {
 }
 
 #[cfg(feature = "secp256k1")]
-#[cfg_attr(docsrs, doc(cfg(feature = "secp256k1")))]
 impl PrivateKey for k256::SecretKey {
     type PublicKey = k256::PublicKey;
 
@@ -59,7 +58,6 @@ impl PrivateKey for k256::SecretKey {
 }
 
 #[cfg(feature = "secp256k1")]
-#[cfg_attr(docsrs, doc(cfg(feature = "secp256k1")))]
 impl PrivateKey for k256::ecdsa::SigningKey {
     type PublicKey = k256::ecdsa::VerifyingKey;
 
@@ -83,23 +81,20 @@ impl PrivateKey for k256::ecdsa::SigningKey {
 }
 
 #[cfg(feature = "secp256k1")]
-#[cfg_attr(docsrs, doc(cfg(feature = "secp256k1")))]
 impl From<XPrv> for k256::ecdsa::SigningKey {
     fn from(xprv: XPrv) -> k256::ecdsa::SigningKey {
         k256::ecdsa::SigningKey::from(&xprv)
     }
 }
 
 #[cfg(feature = "secp256k1")]
-#[cfg_attr(docsrs, doc(cfg(feature = "secp256k1")))]
 impl From<&XPrv> for k256::ecdsa::SigningKey {
     fn from(xprv: &XPrv) -> k256::ecdsa::SigningKey {
         xprv.private_key().clone()
     }
 }
 
 #[cfg(feature = "secp256k1-ffi")]
-#[cfg_attr(docsrs, doc(cfg(feature = "secp256k1-ffi")))]
 impl PrivateKey for secp256k1_ffi::SecretKey {
     type PublicKey = secp256k1_ffi::PublicKey;
 

diff --git a/bip32/src/public_key.rs b/bip32/src/public_key.rs
@@ -36,7 +36,6 @@ pub trait PublicKey: Sized {
 }
 
 #[cfg(feature = "secp256k1")]
-#[cfg_attr(docsrs, doc(cfg(feature = "secp256k1")))]
 impl PublicKey for k256::PublicKey {
     fn from_bytes(bytes: PublicKeyBytes) -> Result<Self> {
         Ok(k256::PublicKey::from_sec1_bytes(&bytes)?)
@@ -60,7 +59,6 @@ impl PublicKey for k256::PublicKey {
 }
 
 #[cfg(feature = "secp256k1")]
-#[cfg_attr(docsrs, doc(cfg(feature = "secp256k1")))]
 impl PublicKey for k256::ecdsa::VerifyingKey {
     fn from_bytes(bytes: PublicKeyBytes) -> Result<Self> {
         Ok(k256::ecdsa::VerifyingKey::from_sec1_bytes(&bytes)?)
@@ -81,23 +79,20 @@ impl PublicKey for k256::ecdsa::VerifyingKey {
 }
 
 #[cfg(feature = "secp256k1")]
-#[cfg_attr(docsrs, doc(cfg(feature = "secp256k1")))]
 impl From<XPub> for k256::ecdsa::VerifyingKey {
     fn from(xpub: XPub) -> k256::ecdsa::VerifyingKey {
         k256::ecdsa::VerifyingKey::from(&xpub)
     }
 }
 
 #[cfg(feature = "secp256k1")]
-#[cfg_attr(docsrs, doc(cfg(feature = "secp256k1")))]
 impl From<&XPub> for k256::ecdsa::VerifyingKey {
     fn from(xpub: &XPub) -> k256::ecdsa::VerifyingKey {
         *xpub.public_key()
     }
 }
 
 #[cfg(feature = "secp256k1-ffi")]
-#[cfg_attr(docsrs, doc(cfg(feature = "secp256k1-ffi")))]
 impl PublicKey for secp256k1_ffi::PublicKey {
     fn from_bytes(bytes: PublicKeyBytes) -> Result<Self> {
         Ok(secp256k1_ffi::PublicKey::from_slice(&bytes)?)

diff --git a/hkd32/src/lib.rs b/hkd32/src/lib.rs
@@ -39,7 +39,7 @@
 //! [bip32]: https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki
 
 #![no_std]
-#![cfg_attr(docsrs, feature(doc_cfg))]
+#![cfg_attr(docsrs, feature(doc_auto_cfg))]
 #![warn(missing_docs, rust_2018_idioms, unused_qualifications)]
 
 #[cfg(feature = "alloc")]

diff --git a/hkd32/src/mnemonic/phrase.rs b/hkd32/src/mnemonic/phrase.rs
@@ -142,7 +142,6 @@ impl Phrase {
 
     /// Convert this mnemonic phrase into the BIP39 seed value.
     #[cfg(feature = "bip39")]
-    #[cfg_attr(docsrs, doc(cfg(feature = "bip39")))]
     pub fn to_seed(&self, password: &str) -> Seed {
         let salt = Zeroizing::new(format!("mnemonic{}", password));
         let mut seed = [0u8; Seed::SIZE];

diff --git a/hkd32/src/mnemonic/seed.rs b/hkd32/src/mnemonic/seed.rs
@@ -4,7 +4,6 @@ use zeroize::Zeroize;
 
 /// BIP39 seeds.
 // TODO(tarcieri): support for 32-byte seeds
-#[cfg_attr(docsrs, doc(cfg(feature = "bip39")))]
 pub struct Seed(pub(crate) [u8; Seed::SIZE]);
 
 impl Seed {

diff --git a/iqhttp/src/error.rs b/iqhttp/src/error.rs
@@ -11,7 +11,6 @@ pub type Result<T> = std::result::Result<T, Error>;
 pub enum Error {
     /// JSON errors
     #[cfg(feature = "json")]
-    #[cfg_attr(docsrs, doc(cfg(feature = "json")))]
     Json(serde_json::Error),
 
     /// Invalid header value
@@ -26,7 +25,6 @@ pub enum Error {
 
     /// Proxy errors
     #[cfg(feature = "proxy")]
-    #[cfg_attr(docsrs, doc(cfg(feature = "proxy")))]
     Proxy(std::io::Error),
 }
 
@@ -65,7 +63,6 @@ impl From<hyper::Error> for Error {
 }
 
 #[cfg(feature = "json")]
-#[cfg_attr(docsrs, doc(cfg(feature = "json")))]
 impl From<serde_json::Error> for Error {
     fn from(err: serde_json::Error) -> Error {
         Error::Json(err)

diff --git a/iqhttp/src/https_client.rs b/iqhttp/src/https_client.rs
@@ -49,7 +49,6 @@ impl HttpsClient {
     /// via the provided HTTP CONNECT proxy.
     // TODO(tarcieri): proxy auth
     #[cfg(feature = "proxy")]
-    #[cfg_attr(docsrs, doc(cfg(feature = "proxy")))]
     pub fn new_with_proxy(hostname: impl Into<String>, proxy_uri: Uri) -> Result<Self> {
         let connector = Self::https_connector();
         let proxy = Proxy::new(Intercept::All, proxy_uri);
@@ -113,7 +112,6 @@ impl HttpsClient {
 
     /// Perform HTTP GET request and parse the response as JSON.
     #[cfg(feature = "json")]
-    #[cfg_attr(docsrs, doc(cfg(feature = "json")))]
     pub async fn get_json<T>(&self, path: &Path, query: &Query) -> Result<T>
     where
         T: DeserializeOwned,

diff --git a/iqhttp/src/lib.rs b/iqhttp/src/lib.rs
@@ -1,5 +1,5 @@
 #![doc = include_str!("../README.md")]
-#![cfg_attr(docsrs, feature(doc_cfg))]
+#![cfg_attr(docsrs, feature(doc_auto_cfg))]
 #![forbid(unsafe_code)]
 #![warn(
     clippy::unwrap_used,
@@ -9,7 +9,6 @@
 )]
 
 #[cfg(feature = "serde")]
-#[cfg_attr(docsrs, doc(cfg(feature = "serde")))]
 pub mod serializers;
 
 mod error;

diff --git a/secrecy/Cargo.toml b/secrecy/Cargo.toml
@@ -6,7 +6,7 @@ they aren't accidentally copied, logged, or otherwise exposed
 (as much as possible), and also ensure secrets are securely wiped
 from memory when dropped.
 """
-version     = "0.9.0-pre" # Also update html_root_url in lib.rs when bumping this
+version     = "0.9.0-pre"
 authors     = ["Tony Arcieri <[email protected]>"]
 license     = "Apache-2.0 OR MIT"
 homepage    = "https://github.com/iqlusioninc/crates/"

diff --git a/secrecy/src/boxed.rs b/secrecy/src/boxed.rs
@@ -5,7 +5,6 @@ use alloc::boxed::Box;
 use zeroize::Zeroize;
 
 /// `Box` types containing a secret value
-#[cfg_attr(docsrs, doc(cfg(feature = "alloc")))]
 pub type SecretBox<S> = Secret<Box<S>>;
 
 impl<S: DebugSecret + Zeroize> DebugSecret for Box<S> {}
diff --git a/secrecy/src/bytes.rs b/secrecy/src/bytes.rs
@@ -14,7 +14,6 @@ use serde::de::{self, Deserialize};
 /// Because of the nature of how the `BytesMut` type works, it needs some special
 /// care in order to have a proper zeroizing drop handler.
 #[derive(Clone)]
-#[cfg_attr(docsrs, doc(cfg(feature = "bytes")))]
 pub struct SecretBytesMut(BytesMut);
 
 impl SecretBytesMut {

diff --git a/secrecy/src/lib.rs b/secrecy/src/lib.rs
@@ -71,8 +71,7 @@
 //! the [`SerializableSecret`] marker trait on `T`.
 
 #![no_std]
-#![cfg_attr(docsrs, feature(doc_cfg))]
-#![doc(html_root_url = "https://docs.rs/secrecy/0.8.0")]
+#![cfg_attr(docsrs, feature(doc_auto_cfg))]
 #![forbid(unsafe_code)]
 #![warn(missing_docs, rust_2018_idioms, unused_qualifications)]
 
@@ -255,7 +254,6 @@ impl_debug_secret_for_array!(
 /// [1]: https://docs.rs/secrecy/latest/secrecy/struct.Secret.html#implementations
 /// [2]: https://serde.rs/field-attrs.html#serialize_with
 #[cfg(feature = "serde")]
-#[cfg_attr(docsrs, doc(cfg(feature = "serde")))]
 pub trait SerializableSecret: Serialize {}
 
 #[cfg(feature = "serde")]

diff --git a/secrecy/src/string.rs b/secrecy/src/string.rs
@@ -5,7 +5,6 @@ use alloc::str::FromStr;
 use alloc::string::{String, ToString};
 
 /// Secret strings
-#[cfg_attr(docsrs, doc(cfg(feature = "alloc")))]
 pub type SecretString = Secret<String>;
 
 impl DebugSecret for String {}

diff --git a/secrecy/src/vec.rs b/secrecy/src/vec.rs
@@ -5,7 +5,6 @@ use alloc::vec::Vec;
 use zeroize::Zeroize;
 
 /// `Vec` types containing secret value
-#[cfg_attr(docsrs, doc(cfg(feature = "alloc")))]
 pub type SecretVec<S> = Secret<Vec<S>>;
 
 impl<S: CloneableSecret + Zeroize> CloneableSecret for Vec<S> {}

diff --git a/signatory/src/algorithm.rs b/signatory/src/algorithm.rs
@@ -11,22 +11,18 @@ use crate::ed25519;
 pub enum Algorithm {
     /// ECDSA with NIST P-256.
     #[cfg(feature = "nistp256")]
-    #[cfg_attr(docsrs, doc(cfg(feature = "nistp256")))]
     EcdsaNistP256,
 
     /// ECDSA with NIST P-384.
     #[cfg(feature = "nistp384")]
-    #[cfg_attr(docsrs, doc(cfg(feature = "nistp384")))]
     EcdsaNistP384,
 
     /// ECDSA with secp256k1.
     #[cfg(feature = "secp256k1")]
-    #[cfg_attr(docsrs, doc(cfg(feature = "secp256k1")))]
     EcdsaSecp256k1,
 
     /// Ed25519.
     #[cfg(feature = "ed25519")]
-    #[cfg_attr(docsrs, doc(cfg(feature = "ed25519")))]
     Ed25519,
 }
 

diff --git a/signatory/src/ecdsa.rs b/signatory/src/ecdsa.rs
@@ -1,15 +1,12 @@
 //! Elliptic Curve Digital Signature Algorithm (ECDSA) support.
 
 #[cfg(feature = "nistp256")]
-#[cfg_attr(docsrs, doc(cfg(feature = "nistp256")))]
 pub mod nistp256;
 
 #[cfg(feature = "nistp384")]
-#[cfg_attr(docsrs, doc(cfg(feature = "nistp384")))]
 pub mod nistp384;
 
 #[cfg(feature = "secp256k1")]
-#[cfg_attr(docsrs, doc(cfg(feature = "secp256k1")))]
 pub mod secp256k1;
 
 mod keyring;
@@ -18,13 +15,10 @@ pub use self::keyring::KeyRing;
 pub use ecdsa::{elliptic_curve, Signature};
 
 #[cfg(feature = "nistp256")]
-#[cfg_attr(docsrs, doc(cfg(feature = "nistp256")))]
 pub use {self::nistp256::NistP256Signer, p256::NistP256};
 
 #[cfg(feature = "nistp384")]
-#[cfg_attr(docsrs, doc(cfg(feature = "nistp384")))]
 pub use {self::nistp384::NistP384Signer, p384::NistP384};
 
 #[cfg(feature = "secp256k1")]
-#[cfg_attr(docsrs, doc(cfg(feature = "secp256k1")))]
 pub use {self::secp256k1::Secp256k1Signer, k256::Secp256k1};