From 042dcaa4b7d5752ec7df95e484c2441102e8d9c4 Mon Sep 17 00:00:00 2001 From: "Tobin C. Harding" Date: Tue, 30 May 2023 15:54:40 +1000 Subject: [PATCH] Remove doc(hidden) from error conversion functions Give people access to the error type conversion docs, its no harm and it may be useful when the compiler does not give enough information. --- bitcoin/src/address.rs | 2 -- bitcoin/src/blockdata/script/mod.rs | 1 - bitcoin/src/consensus/encode.rs | 1 - bitcoin/src/crypto/key.rs | 3 --- bitcoin/src/psbt/error.rs | 1 - bitcoin/src/sign_message.rs | 1 - 6 files changed, 9 deletions(-) diff --git a/bitcoin/src/address.rs b/bitcoin/src/address.rs index 50b51f6f..5e66a077 100644 --- a/bitcoin/src/address.rs +++ b/bitcoin/src/address.rs @@ -148,12 +148,10 @@ impl std::error::Error for Error { } } -#[doc(hidden)] impl From for Error { fn from(e: base58::Error) -> Error { Error::Base58(e) } } -#[doc(hidden)] impl From for Error { fn from(e: bech32::Error) -> Error { Error::Bech32(e) } } diff --git a/bitcoin/src/blockdata/script/mod.rs b/bitcoin/src/blockdata/script/mod.rs index b688ff13..cc749974 100644 --- a/bitcoin/src/blockdata/script/mod.rs +++ b/bitcoin/src/blockdata/script/mod.rs @@ -779,7 +779,6 @@ impl From for Error { } #[cfg(feature = "bitcoinconsensus")] -#[doc(hidden)] impl From for Error { fn from(err: bitcoinconsensus::Error) -> Error { Error::BitcoinConsensus(err) } } diff --git a/bitcoin/src/consensus/encode.rs b/bitcoin/src/consensus/encode.rs index 7f6e2f0e..1ff023cc 100644 --- a/bitcoin/src/consensus/encode.rs +++ b/bitcoin/src/consensus/encode.rs @@ -93,7 +93,6 @@ impl std::error::Error for Error { } } -#[doc(hidden)] impl From for Error { fn from(error: io::Error) -> Self { Error::Io(error) } } diff --git a/bitcoin/src/crypto/key.rs b/bitcoin/src/crypto/key.rs index 605e8b88..2425d6f8 100644 --- a/bitcoin/src/crypto/key.rs +++ b/bitcoin/src/crypto/key.rs @@ -65,17 +65,14 @@ impl std::error::Error for Error { } } -#[doc(hidden)] impl From for Error { fn from(e: base58::Error) -> Error { Error::Base58(e) } } -#[doc(hidden)] impl From for Error { fn from(e: secp256k1::Error) -> Error { Error::Secp256k1(e) } } -#[doc(hidden)] impl From for Error { fn from(e: hex::Error) -> Self { Error::Hex(e) } } diff --git a/bitcoin/src/psbt/error.rs b/bitcoin/src/psbt/error.rs index 778086b8..f08940ae 100644 --- a/bitcoin/src/psbt/error.rs +++ b/bitcoin/src/psbt/error.rs @@ -203,7 +203,6 @@ impl std::error::Error for Error { } } -#[doc(hidden)] impl From for Error { fn from(e: hashes::FromSliceError) -> Error { Error::HashParse(e) } } diff --git a/bitcoin/src/sign_message.rs b/bitcoin/src/sign_message.rs index 52f445a4..94b0658f 100644 --- a/bitcoin/src/sign_message.rs +++ b/bitcoin/src/sign_message.rs @@ -68,7 +68,6 @@ mod message_signing { } } - #[doc(hidden)] impl From for MessageSignatureError { fn from(e: secp256k1::Error) -> MessageSignatureError { MessageSignatureError::InvalidEncoding(e)