From 7ba770ad4427d1b174ad79af110b5ebcd1ecb165 Mon Sep 17 00:00:00 2001 From: github-actions Date: Sat, 2 Apr 2022 02:39:51 +0000 Subject: [PATCH] Publish autogenerated nightly docs --- .../docs-rs/bdk/nightly/latest/bdk/fn.version.html | 2 +- .../public/docs-rs/bdk/nightly/latest/bdk/index.html | 12 ++++++------ .../docs-rs/bdk/nightly/latest/src/bdk/lib.rs.html | 10 +++------- 3 files changed, 10 insertions(+), 14 deletions(-) diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/fn.version.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/fn.version.html index 91b68dbc81..d6442bd010 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/fn.version.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/fn.version.html @@ -6,6 +6,6 @@ logo

In bdk

logo
-

Function bdk::version

source · [−]
pub fn version() -> &'static str
Expand description

Get the version of BDK at runtime

+

Function bdk::version

source · [−]
pub fn version() -> &'static str
Expand description

Get the version of BDK at runtime

\ No newline at end of file diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/index.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/index.html index fe59bec85b..816922df6c 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/index.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/bdk/index.html @@ -6,7 +6,7 @@ logo

Crate bdk

logo
-

Crate bdk

source · [−]
Expand description

A modern, lightweight, descriptor-based wallet library written in Rust.

+

Crate bdk

source · [−]
Expand description

A modern, lightweight, descriptor-based wallet library written in Rust.

About

The BDK library aims to be the core building block for Bitcoin wallets of any kind.

    @@ -25,7 +25,7 @@ their uses.

    The default features include a simple key-value database (sled) to cache blockchain data and an electrum blockchain client to interact with the bitcoin P2P network.

    -
    bdk = "0.17.0"

    Sync the balance of a descriptor

    Example

    +
    bdk = "0.17.0"

    Examples

    Sync the balance of a descriptor

    use bdk::{Wallet, SyncOptions};
 use bdk::database::MemoryDatabase;
 use bdk::blockchain::ElectrumBlockchain;
@@ -47,7 +47,7 @@ interact with the bitcoin P2P network.
    
 
     Ok(())
 }
    -

    Generate a few addresses

    Example

    +

    Generate a few addresses

    use bdk::{Wallet};
 use bdk::database::MemoryDatabase;
 use bdk::wallet::AddressIndex::New;
@@ -66,7 +66,7 @@ interact with the bitcoin P2P network.
    
 
     Ok(())
 }
    -

    Create a transaction

    Example

    +

    Create a transaction

    use bdk::{FeeRate, Wallet, SyncOptions};
 use bdk::database::MemoryDatabase;
 use bdk::blockchain::ElectrumBlockchain;
@@ -103,7 +103,7 @@ interact with the bitcoin P2P network.
    
 
     Ok(())
 }
    -

    Sign a transaction

    Example

    +

    Sign a transaction

    use std::str::FromStr;
 
 use bitcoin::util::psbt::PartiallySignedTransaction as Psbt;
@@ -139,7 +139,7 @@ Below is a list of the available feature flags and the additional functionality
 
  • async-interface: async functions in bdk traits
    • 
 
  • keys-bip39: BIP-39 mnemonic codes for generating deterministic keys
    •
-

Internal features

+

Internal features

These features do not expose any new API, but influence internal implementation aspects of BDK.

    diff --git a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/src/bdk/lib.rs.html b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/src/bdk/lib.rs.html index 31c42bc371..1e0206b27f 100644 --- a/docs/.vuepress/public/docs-rs/bdk/nightly/latest/src/bdk/lib.rs.html +++ b/docs/.vuepress/public/docs-rs/bdk/nightly/latest/src/bdk/lib.rs.html @@ -291,8 +291,6 @@ 284 285 286 -287 -288 
    // Bitcoin Dev Kit
 // Written in 2020 by Alekos Filini <alekos.filini@gmail.com>
 //
@@ -341,12 +339,13 @@
 //! ```toml
 //! bdk = "0.17.0"
 //! ```
+//!
+//! # Examples
 #![cfg_attr(
     feature = "electrum",
     doc = r##"
 ## Sync the balance of a descriptor
 
-### Example
 ```no_run
 use bdk::{Wallet, SyncOptions};
 use bdk::database::MemoryDatabase;
@@ -375,7 +374,6 @@ fn main() -> Result<(), bdk::Error> {
 //!
 //! ## Generate a few addresses
 //!
-//! ### Example
 //! ```
 //! use bdk::{Wallet};
 //! use bdk::database::MemoryDatabase;
@@ -401,7 +399,6 @@ fn main() -> Result<(), bdk::Error> {
     doc = r##"
 ## Create a transaction
 
-### Example
 ```no_run
 use bdk::{FeeRate, Wallet, SyncOptions};
 use bdk::database::MemoryDatabase;
@@ -445,7 +442,6 @@ fn main() -> Result<(), bdk::Error> {
 //!
 //! ## Sign a transaction
 //!
-//! ### Example
 //! ```no_run
 //! use std::str::FromStr;
 //!
@@ -487,7 +483,7 @@ fn main() -> Result<(), bdk::Error> {
 //! * `async-interface`: async functions in bdk traits
 //! * `keys-bip39`: [BIP-39](https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki) mnemonic codes for generating deterministic keys
 //!
-//! ## Internal features
+//! # Internal features
 //!
 //! These features do not expose any new API, but influence internal implementation aspects of
 //! BDK.
-- 
2.49.0