From ef728b58037e3e67c781705d5e0aefbbd42bde54 Mon Sep 17 00:00:00 2001 From: Thomas Coratger <60488569+tcoratger@users.noreply.github.com> Date: Tue, 6 Aug 2024 14:33:41 +0200 Subject: [PATCH] typo: replace [BlockId] by [`BlockId`] (#10121) Co-authored-by: nk_ysg --- crates/storage/storage-api/src/block.rs | 4 ++-- crates/storage/storage-api/src/block_id.rs | 6 +++--- crates/storage/storage-api/src/state.rs | 2 +- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/crates/storage/storage-api/src/block.rs b/crates/storage/storage-api/src/block.rs index fe97fb3713..569a1e7fff 100644 --- a/crates/storage/storage-api/src/block.rs +++ b/crates/storage/storage-api/src/block.rs @@ -200,12 +200,12 @@ pub trait BlockReaderIdExt: BlockReader + BlockIdReader + ReceiptProviderIdExt { self.sealed_header_by_id(BlockNumberOrTag::Finalized.into()) } - /// Returns the block with the matching [BlockId] from the database. + /// Returns the block with the matching [`BlockId`] from the database. /// /// Returns `None` if block is not found. fn block_by_id(&self, id: BlockId) -> ProviderResult>; - /// Returns the block with senders with matching [BlockId]. + /// Returns the block with senders with matching [`BlockId`]. /// /// Returns the block's transactions in the requested variant. /// diff --git a/crates/storage/storage-api/src/block_id.rs b/crates/storage/storage-api/src/block_id.rs index af2b27d947..db40dff24a 100644 --- a/crates/storage/storage-api/src/block_id.rs +++ b/crates/storage/storage-api/src/block_id.rs @@ -40,10 +40,10 @@ pub trait BlockNumReader: BlockHashReader + Send + Sync { } } -/// Client trait for transforming [BlockId] into block numbers or hashes. +/// Client trait for transforming [`BlockId`] into block numbers or hashes. /// -/// Types that implement this trait must be able to resolve all variants of [BlockNumberOrTag] to -/// block numbers or hashes. Automatic implementations for resolving [BlockNumberOrTag] variants +/// Types that implement this trait must be able to resolve all variants of [`BlockNumberOrTag`] to +/// block numbers or hashes. Automatic implementations for resolving [`BlockNumberOrTag`] variants /// are provided if the type implements the `pending_block_num_hash`, `finalized_block_num`, and /// `safe_block_num` methods. /// diff --git a/crates/storage/storage-api/src/state.rs b/crates/storage/storage-api/src/state.rs index 0147cb2ef9..b82567fba5 100644 --- a/crates/storage/storage-api/src/state.rs +++ b/crates/storage/storage-api/src/state.rs @@ -101,7 +101,7 @@ pub trait StateProviderFactory: BlockIdReader + Send + Sync { /// Storage provider for latest block. fn latest(&self) -> ProviderResult; - /// Returns a [StateProvider] indexed by the given [BlockId]. + /// Returns a [`StateProvider`] indexed by the given [`BlockId`]. /// /// Note: if a number or hash is provided this will __only__ look at historical(canonical) /// state.