Skip to content

Commit 9294e30

Browse files
committed
docs(wallet): improve docs for unbounded spk iterator methods
1 parent b74c2e2 commit 9294e30

File tree

1 file changed

+2
-3
lines changed

1 file changed

+2
-3
lines changed

crates/bdk/src/wallet/mod.rs

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -811,8 +811,7 @@ impl<D> Wallet<D> {
811811
self.chain.tip()
812812
}
813813

814-
/// Returns a iterators of all the script pubkeys for the `Internal` and `External` variants in
815-
/// `KeychainKind`.
814+
/// Get unbounded script pubkey iterators for both `Internal` and `External` keychains.
816815
///
817816
/// This is intended to be used when doing a full scan of your addresses (e.g. after restoring
818817
/// from seed words). You pass the `BTreeMap` of iterators to a blockchain data source (e.g.
@@ -826,7 +825,7 @@ impl<D> Wallet<D> {
826825
self.indexed_graph.index.all_unbounded_spk_iters()
827826
}
828827

829-
/// Gets an iterator over all the script pubkeys in a single keychain.
828+
/// Get an unbounded script pubkey iterator for the given `keychain`.
830829
///
831830
/// See [`all_unbounded_spk_iters`] for more documentation
832831
///

0 commit comments

Comments
 (0)