8968819480

Committed 06 May 2024 12:09PM UTC coverage: 82.273%. Remained the same

Build # 8968819480

Build Type

push

github

Committed by

evanlinjin

Commit Message

Merge bitcoindevkit/bdk#1427: docs(esplora): fixed `full_scan` and `sync` documentation

<a class=hub.com/bitcoindevkit/bdk/commit/<a class="double-link" href="https://git"><a class=hub.com/bitcoindevkit/bdk/commit/f6dc6890c37752e80c86c68ae3ca3cc4fac6245e">f6dc6890c docs(esplora): fixed `full_scan` and `sync` documentation (Wei Chen)

Pull request description:

  <!-- You can erase any parts of this template not applicable to your Pull Request. -->

  ### Description

  Fixed documentation for `full_scan` and `sync` in `bdk_esplora`.

  ### Changelog notice

  <!-- Notice the release manager should include in the release tag message changelog -->
  <!-- See https://keepachangelog.com/en/1.0.0/ for examples -->
  * Updated documentation for `full_scan` and `sync` in `bdk_esplora`.

  ### Checklists

  #### All Submissions:

  * [x] I've signed all my commits
  * [x] I followed the [contribution guidelines](https://github.com/bitcoindevkit/bdk/blob/master/CONTRIBUTING.md)
  * [x] I ran `cargo fmt` and `cargo clippy` before committing

ACKs for top commit:
  evanlinjin:
    ACK f6dc6890c37752e80c86c68ae3ca3cc4fac6245e
  storopoli:
    ACK f6dc6890c37752e80c86c68ae3ca3cc4fac6245e

Tree-SHA512: 900fb1a280a72ee1e13c5c70a136b93f332

Run Details

10396 of 12636 relevant lines covered (82.27%)

17655.35 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

0.0

/crates/bdk/src/lib.rs

#![doc = include_str!("../README.md")]
// only enables the `doc_cfg` feature when the `docsrs` configuration attribute is defined
#![cfg_attr(docsrs, feature(doc_cfg))]
#![cfg_attr(
    docsrs,
    doc(html_logo_url = "https://github.com/bitcoindevkit/bdk/raw/master/static/bdk.png")
)]
#![no_std]
#![warn(missing_docs)]

#[cfg(feature = "std")]
#[macro_use]
extern crate std;

#[doc(hidden)]
#[macro_use]
pub extern crate alloc;

pub extern crate bitcoin;
pub extern crate miniscript;
extern crate serde;
extern crate serde_json;

#[cfg(feature = "keys-bip39")]
extern crate bip39;

pub mod descriptor;
pub mod keys;
pub mod psbt;
pub(crate) mod types;
pub mod wallet;

pub use descriptor::template;
pub use descriptor::HdKeyPaths;
pub use types::*;
pub use wallet::signer;
pub use wallet::signer::SignOptions;
pub use wallet::tx_builder::TxBuilder;
pub use wallet::Wallet;

/// Get the version of BDK at runtime
pub fn version() -> &'static str {
    env!("CARGO_PKG_VERSION", "unknown")
}

pub use bdk_chain as chain;
pub(crate) use bdk_chain::collections;

1	#![doc = include_str!("../README.md")]
2	// only enables the `doc_cfg` feature when the `docsrs` configuration attribute is defined
3	#![cfg_attr(docsrs, feature(doc_cfg))]
4	#![cfg_attr(
5	docsrs,
6	doc(html_logo_url = "https://github.com/bitcoindevkit/bdk/raw/master/static/bdk.png")
7	)]
8	#![no_std]
9	#![warn(missing_docs)]
10
11	#[cfg(feature = "std")]
12	#[macro_use]
13	extern crate std;
14
15	#[doc(hidden)]
16	#[macro_use]
17	pub extern crate alloc;
18
19	pub extern crate bitcoin;
20	pub extern crate miniscript;
21	extern crate serde;
22	extern crate serde_json;
23
24	#[cfg(feature = "keys-bip39")]
25	extern crate bip39;
26
27	pub mod descriptor;
28	pub mod keys;
29	pub mod psbt;
30	pub(crate) mod types;
31	pub mod wallet;
32
33	pub use descriptor::template;
34	pub use descriptor::HdKeyPaths;
35	pub use types::*;
36	pub use wallet::signer;
37	pub use wallet::signer::SignOptions;
38	pub use wallet::tx_builder::TxBuilder;
39	pub use wallet::Wallet;
40
41	/// Get the version of BDK at runtime
42	pub fn version() -> &'static str {	×
43	env!("CARGO_PKG_VERSION", "unknown")	×
44	}	×
45
46	pub use bdk_chain as chain;
47	pub(crate) use bdk_chain::collections;

bitcoindevkit / bdk / 8968819480

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous