]> Untitled Git - bdk/commitdiff
Add TODOs for missing_docs
authorSteve Myers <steve@notmandatory.org>
Tue, 8 Dec 2020 02:21:18 +0000 (18:21 -0800)
committerSteve Myers <steve@notmandatory.org>
Tue, 8 Dec 2020 02:25:16 +0000 (18:25 -0800)
src/descriptor/mod.rs
src/wallet/mod.rs

index ccd995691a79d4ff5219ac9ac6615a0c139a7b1e..cae0654a52c41fc5bb8583fb93b28a915e806227 100644 (file)
@@ -44,7 +44,9 @@ pub use miniscript::{
 pub mod checksum;
 mod dsl;
 pub mod error;
+#[allow(missing_docs)] // TODO add missing docs and remove this allow
 pub mod policy;
+#[allow(missing_docs)] // TODO add missing docs and remove this allow
 pub mod template;
 
 pub use self::checksum::get_checksum;
@@ -64,6 +66,7 @@ pub type ExtendedDescriptor = Descriptor<DescriptorPublicKey>;
 /// [`psbt::Output`]: bitcoin::util::psbt::Output
 pub type HDKeyPaths = BTreeMap<PublicKey, (Fingerprint, DerivationPath)>;
 
+#[allow(missing_docs)] // TODO add missing docs and remove this allow
 /// Trait for types which can be converted into an [`ExtendedDescriptor`] and a [`KeyMap`] usable by a wallet in a specific [`Network`]
 pub trait ToWalletDescriptor {
     fn to_wallet_descriptor(
@@ -185,6 +188,7 @@ impl ToWalletDescriptor for (ExtendedDescriptor, KeyMap, ValidNetworks) {
     }
 }
 
+#[allow(missing_docs)] // TODO add missing docs and remove this allow
 /// Trait implemented on [`Descriptor`]s to add a method to extract the spending [`policy`]
 pub trait ExtractPolicy {
     fn extract_policy(
index a6c64a6cd8f652fe7f18ac01d1db9006cb3e5fb1..8621d192e304caa37d9d449c4b5dd5fe4da2bb3f 100644 (file)
@@ -46,11 +46,15 @@ use miniscript::psbt::PsbtInputSatisfier;
 #[allow(unused_imports)]
 use log::{debug, error, info, trace};
 
+#[allow(missing_docs)] // TODO add missing docs and remove this allow
 pub mod address_validator;
+#[allow(missing_docs)] // TODO add missing docs and remove this allow
 pub mod coin_selection;
 pub mod export;
+#[allow(missing_docs)] // TODO add missing docs and remove this allow
 pub mod signer;
 pub mod time;
+#[allow(missing_docs)] // TODO add missing docs and remove this allow
 pub mod tx_builder;
 pub(crate) mod utils;
 
@@ -930,6 +934,7 @@ where
         Ok((psbt, finished))
     }
 
+    #[allow(missing_docs)] // TODO add missing docs and remove this allow
     pub fn secp_ctx(&self) -> &SecpCtx {
         &self.secp
     }