frost/bdk
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add TODOs for missing_docs

Browse Source
This commit is contained in:
Steve Myers
2020-12-07 18:21:18 -08:00
parent 3491bfbf30
commit 602ae3d63a
2 changed files with 9 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
src/descriptor/mod.rs
View 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(