diff --git a/.github/workflows/nightly_docs.yml b/.github/workflows/nightly_docs.yml index 1e3f61394..a4a837c7a 100644 --- a/.github/workflows/nightly_docs.yml +++ b/.github/workflows/nightly_docs.yml @@ -24,7 +24,9 @@ jobs: - name: Update toolchain run: rustup update - name: Build docs - run: cargo rustdoc --verbose --all-features -- --cfg docsrs -Dwarnings + run: cargo doc --no-deps + env: + RUSTDOCFLAGS: '--cfg docsrs -Dwarnings' - name: Upload artifact uses: actions/upload-artifact@v2 with: diff --git a/crates/bdk/src/descriptor/dsl.rs b/crates/bdk/src/descriptor/dsl.rs index e689a540a..60fac19e5 100644 --- a/crates/bdk/src/descriptor/dsl.rs +++ b/crates/bdk/src/descriptor/dsl.rs @@ -495,6 +495,8 @@ macro_rules! apply_modifier { /// let (descriptor, key_map, networks) = bdk::descriptor!(wpkh(my_key))?; /// # Ok::<(), Box>(()) /// ``` +/// +/// [`Vec`]: alloc::vec::Vec #[macro_export] macro_rules! descriptor { ( bare ( $( $minisc:tt )* ) ) => ({ diff --git a/crates/bdk/src/keys/mod.rs b/crates/bdk/src/keys/mod.rs index 0f5e386e7..e8c9ca07e 100644 --- a/crates/bdk/src/keys/mod.rs +++ b/crates/bdk/src/keys/mod.rs @@ -462,12 +462,11 @@ impl From for ExtendedKey { /// [`ExtendedPubKey`]: (bip32::ExtendedPubKey) pub trait DerivableKey: Sized { /// Consume `self` and turn it into an [`ExtendedKey`] - /// - /// This can be used to get direct access to `xprv`s and `xpub`s for types that implement this trait, - /// like [`Mnemonic`](bip39::Mnemonic) when the `keys-bip39` feature is enabled. #[cfg_attr( feature = "keys-bip39", doc = r##" +This can be used to get direct access to `xprv`s and `xpub`s for types that implement this trait, +like [`Mnemonic`](bip39::Mnemonic) when the `keys-bip39` feature is enabled. ```rust use bdk::bitcoin::Network; use bdk::keys::{DerivableKey, ExtendedKey}; diff --git a/crates/bdk/src/wallet/mod.rs b/crates/bdk/src/wallet/mod.rs index 862a5d68c..e812048f1 100644 --- a/crates/bdk/src/wallet/mod.rs +++ b/crates/bdk/src/wallet/mod.rs @@ -90,7 +90,7 @@ pub struct Wallet { secp: SecpCtx, } -/// The update to a [`Wallet`] used in [Wallet::apply_update]. This is usually returned from blockchain data sources. +/// The update to a [`Wallet`] used in [`Wallet::apply_update`]. This is usually returned from blockchain data sources. /// The type parameter `T` indicates the kind of transaction contained in the update. It's usually a [`bitcoin::Transaction`]. pub type Update = KeychainScan; /// Error indicating that something was wrong with an [`Update`]. @@ -1689,7 +1689,7 @@ impl Wallet { /// transactions related to your wallet into it. /// /// [`commit`]: Self::commit - pub fn apply_udpate(&mut self, update: Update) -> Result<(), UpdateError> + pub fn apply_update(&mut self, update: Update) -> Result<(), UpdateError> where D: persist::Backend, Tx: IntoOwned + Clone, diff --git a/crates/bdk/src/wallet/persist.rs b/crates/bdk/src/wallet/persist.rs index c6d65ce6e..a947ef3c0 100644 --- a/crates/bdk/src/wallet/persist.rs +++ b/crates/bdk/src/wallet/persist.rs @@ -6,6 +6,8 @@ //! //! Note that `Wallet` does not read this persisted data during operation since it always has a copy //! in memory +//! +//! [`Wallet`]: crate::Wallet use crate::KeychainKind; use bdk_chain::{keychain::KeychainTracker, ConfirmationTime}; @@ -13,6 +15,8 @@ use bdk_chain::{keychain::KeychainTracker, ConfirmationTime}; /// persisted. Not all changes made to the [`Wallet`] need to be written to disk right away so you /// can use [`Persist::stage`] to *stage* it first and then [`Persist::commit`] to finally write it /// to disk. +/// +/// [`Wallet`]: crate::Wallet #[derive(Debug)] pub struct Persist

{ backend: P,