[docs] Various fixes to the docs

diff --git a/src/blockchain/mod.rs b/src/blockchain/mod.rs
index 6711e51ea787e873ffc1aee99badc9104e947198..9f021275f3ffa5e9e21950905d012bf3f76078bb 100644 (file)
--- a/src/blockchain/mod.rs
+++ b/src/blockchain/mod.rs
@@ -95,7 +95,7 @@ pub trait BlockchainMarker {}
 /// The [`BlockchainMarker`] marker trait is automatically implemented for [`Blockchain`] types
 impl<T: Blockchain> BlockchainMarker for T {}
 
-/// Type that only implements [`Blockchain`] and is always "offline"
+/// Type that only implements [`BlockchainMarker`] and is always "offline"
 pub struct OfflineBlockchain;
 impl BlockchainMarker for OfflineBlockchain {}
 

diff --git a/src/descriptor/dsl.rs b/src/descriptor/dsl.rs
index 969fb8454782925c1994bd568fae3aa2de1ed66d..e75e1b58ce2cc4c4fef1c609792c8856a00775b7 100644 (file)
--- a/src/descriptor/dsl.rs
+++ b/src/descriptor/dsl.rs
@@ -201,7 +201,8 @@ macro_rules! impl_sortedmulti {
 
 /// Macro to write full descriptors with code
 ///
-/// This macro expands to an object of type `Result<(Descriptor<DescriptorPublicKey>, KeyMap, ValidNetworks), Error>`.
+/// This macro expands to a `Result` of
+/// [`DescriptorTemplateOut`](super::template::DescriptorTemplateOut) and [`Error`](crate::Error)
 ///
 /// ## Example
 ///

diff --git a/src/descriptor/mod.rs b/src/descriptor/mod.rs
index cae0654a52c41fc5bb8583fb93b28a915e806227..38cc8d8e589f9cc8099a302ee10d8cf8b8a661d5 100644 (file)
--- a/src/descriptor/mod.rs
+++ b/src/descriptor/mod.rs
@@ -52,7 +52,8 @@ pub mod template;
 pub use self::checksum::get_checksum;
 use self::error::Error;
 pub use self::policy::Policy;
-use crate::keys::{KeyError, ToDescriptorKey, ValidNetworks};
+use self::template::DescriptorTemplateOut;
+use crate::keys::{KeyError, ToDescriptorKey};
 use crate::wallet::signer::SignersContainer;
 use crate::wallet::utils::{descriptor_to_pk_ctx, SecpCtx};
 
@@ -151,7 +152,7 @@ impl ToWalletDescriptor for (ExtendedDescriptor, KeyMap) {
     }
 }
 
-impl ToWalletDescriptor for (ExtendedDescriptor, KeyMap, ValidNetworks) {
+impl ToWalletDescriptor for DescriptorTemplateOut {
     fn to_wallet_descriptor(
         self,
         network: Network,

diff --git a/src/keys/bip39.rs b/src/keys/bip39.rs
index bf9837c426d78e8f8ccad3079ff64a6c5ec5e600..b7f7765e47fa6cc7c57ada76e094fc317e4d80ae 100644 (file)
--- a/src/keys/bip39.rs
+++ b/src/keys/bip39.rs
@@ -36,8 +36,10 @@ use bip39::{Language, Mnemonic, MnemonicType, Seed};
 
 use super::{any_network, DerivableKey, DescriptorKey, GeneratableKey, GeneratedKey, KeyError};
 
+/// Type for a BIP39 mnemonic with an optional passphrase
 pub type MnemonicWithPassphrase = (Mnemonic, Option<String>);
 
+#[cfg_attr(docsrs, doc(cfg(feature = "keys-bip39")))]
 impl<Ctx: ScriptContext> DerivableKey<Ctx> for Seed {
     fn add_metadata(
         self,
@@ -54,6 +56,7 @@ impl<Ctx: ScriptContext> DerivableKey<Ctx> for Seed {
     }
 }
 
+#[cfg_attr(docsrs, doc(cfg(feature = "keys-bip39")))]
 impl<Ctx: ScriptContext> DerivableKey<Ctx> for MnemonicWithPassphrase {
     fn add_metadata(
         self,
@@ -66,6 +69,7 @@ impl<Ctx: ScriptContext> DerivableKey<Ctx> for MnemonicWithPassphrase {
     }
 }
 
+#[cfg_attr(docsrs, doc(cfg(feature = "keys-bip39")))]
 impl<Ctx: ScriptContext> DerivableKey<Ctx> for Mnemonic {
     fn add_metadata(
         self,
@@ -76,6 +80,7 @@ impl<Ctx: ScriptContext> DerivableKey<Ctx> for Mnemonic {
     }
 }
 
+#[cfg_attr(docsrs, doc(cfg(feature = "keys-bip39")))]
 impl<Ctx: ScriptContext> GeneratableKey<Ctx> for Mnemonic {
     type Entropy = [u8; 32];
 

diff --git a/src/wallet/coin_selection.rs b/src/wallet/coin_selection.rs
index 5063f745db08695455edebc20a4dc54dfd11d75e..7f6656b05feea1c3ad4d690206303c6547fee083 100644 (file)
--- a/src/wallet/coin_selection.rs
+++ b/src/wallet/coin_selection.rs
@@ -257,8 +257,9 @@ impl OutputGroup {
     }
 }
 
-/// Branch and bound coin selection. Code adapted from Bitcoin Core's implementation and from Mark
-/// Erhardt Master's Thesis (http://murch.one/wp-content/uploads/2016/11/erhardt2016coinselection.pdf)
+/// Branch and bound coin selection
+///
+/// Code adapted from Bitcoin Core's implementation and from Mark Erhardt Master's Thesis: <http://murch.one/wp-content/uploads/2016/11/erhardt2016coinselection.pdf>
 #[derive(Debug)]
 pub struct BranchAndBoundCoinSelection {
     size_of_change: u64,