Skip to content

Commit b6a58d4

Browse files
committed
doc(chain,esplora): minor documentation improvements
* Corrects an awkward use of the word 'an' * Adds missing backticks, brackets in a few places
1 parent 40f0765 commit b6a58d4

File tree

4 files changed

+4
-4
lines changed

4 files changed

+4
-4
lines changed

crates/chain/src/keychain.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ pub use txout_index::*;
2020
/// Represents updates to the derivation index of a [`KeychainTxOutIndex`].
2121
/// It maps each keychain `K` to its last revealed index.
2222
///
23-
/// It can be applied to [`KeychainTxOutIndex`] with [`apply_changeset`]. [`ChangeSet] are
23+
/// It can be applied to [`KeychainTxOutIndex`] with [`apply_changeset`]. [`ChangeSet`]s are
2424
/// monotone in that they will never decrease the revealed derivation index.
2525
///
2626
/// [`KeychainTxOutIndex`]: crate::keychain::KeychainTxOutIndex

crates/chain/src/tx_graph.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -337,7 +337,7 @@ impl<A> TxGraph<A> {
337337

338338
/// The transactions spending from this output.
339339
///
340-
/// `TxGraph` allows conflicting transactions within the graph. Obviously the transactions in
340+
/// [`TxGraph`] allows conflicting transactions within the graph. Obviously the transactions in
341341
/// the returned set will never be in the same active-chain.
342342
pub fn outspends(&self, outpoint: OutPoint) -> &HashSet<Txid> {
343343
self.spends.get(&outpoint).unwrap_or(&self.empty_outspends)

crates/esplora/src/async_ext.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ use crate::{anchor_from_status, ASSUME_FINAL_DEPTH};
1919
#[cfg_attr(target_arch = "wasm32", async_trait(?Send))]
2020
#[cfg_attr(not(target_arch = "wasm32"), async_trait)]
2121
pub trait EsploraAsyncExt {
22-
/// Prepare an [`LocalChain`] update with blocks fetched from Esplora.
22+
/// Prepare a [`LocalChain`] update with blocks fetched from Esplora.
2323
///
2424
/// * `local_tip` is the previous tip of [`LocalChain::tip`].
2525
/// * `request_heights` is the block heights that we are interested in fetching from Esplora.

crates/esplora/src/blocking_ext.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ use crate::{anchor_from_status, ASSUME_FINAL_DEPTH};
1717
///
1818
/// [crate-level documentation]: crate
1919
pub trait EsploraExt {
20-
/// Prepare an [`LocalChain`] update with blocks fetched from Esplora.
20+
/// Prepare a [`LocalChain`] update with blocks fetched from Esplora.
2121
///
2222
/// * `local_tip` is the previous tip of [`LocalChain::tip`].
2323
/// * `request_heights` is the block heights that we are interested in fetching from Esplora.

0 commit comments

Comments
 (0)