Skip to content

Commit f40adf0

Browse files
committed
docs: clarify comments on TxIndexReader and TxIndexWriter interfaces
1 parent cbbce63 commit f40adf0

1 file changed

Lines changed: 3 additions & 3 deletions

File tree

crates/index/src/index.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1644,7 +1644,7 @@ mod watermark_tests {
16441644

16451645
/// Read-only `TxIndex` interface used by RPC complete queries.
16461646
pub trait TxIndexReader: Send + Sync {
1647-
/// Loads the exact durable watermark from the TxIndex store.
1647+
/// Loads the exact durable watermark from the `TxIndex` store.
16481648
fn watermark(&self) -> Result<Option<IndexWatermark>, IndexError>;
16491649

16501650
/// Resolves a confirmed transaction by txid via `source`.
@@ -1669,9 +1669,9 @@ pub trait TxIndexReader: Send + Sync {
16691669
) -> Result<Option<u64>, IndexError>;
16701670
}
16711671

1672-
/// Mutation-only interface owned by the asynchronous TxIndex worker.
1672+
/// Mutation-only interface owned by the asynchronous `TxIndex` worker.
16731673
pub trait TxIndexWriter: Send + Sync {
1674-
/// Loads the exact durable watermark from the TxIndex store.
1674+
/// Loads the exact durable watermark from the `TxIndex` store.
16751675
fn watermark(&self) -> Result<Option<IndexWatermark>, IndexError>;
16761676

16771677
/// Atomically connects a contiguous slice and publishes its terminal watermark.

0 commit comments

Comments
 (0)