mirror of
https://github.com/paradigmxyz/reth.git
synced 2026-01-09 15:28:01 -05:00
chore: fix clippy docs (#17726)
Co-authored-by: Alexey Shekhirin <5773434+shekhirin@users.noreply.github.com>
This commit is contained in:
@@ -2582,8 +2582,8 @@ pub enum BlockStatus {
|
||||
|
||||
/// How a payload was inserted if it was valid.
|
||||
///
|
||||
/// If the payload was valid, but has already been seen, [`InsertPayloadOk::AlreadySeen(_)`] is
|
||||
/// returned, otherwise [`InsertPayloadOk::Inserted(_)`] is returned.
|
||||
/// If the payload was valid, but has already been seen, [`InsertPayloadOk::AlreadySeen`] is
|
||||
/// returned, otherwise [`InsertPayloadOk::Inserted`] is returned.
|
||||
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
|
||||
pub enum InsertPayloadOk {
|
||||
/// The payload was valid, but we have already seen it.
|
||||
|
||||
@@ -143,7 +143,7 @@ where
|
||||
/// Max requests to handle at the same time
|
||||
///
|
||||
/// This depends on the number of active peers but will always be
|
||||
/// [`min_concurrent_requests`..`max_concurrent_requests`]
|
||||
/// `min_concurrent_requests..max_concurrent_requests`
|
||||
#[inline]
|
||||
fn concurrent_request_limit(&self) -> usize {
|
||||
let num_peers = self.client.num_connected_peers();
|
||||
|
||||
@@ -148,7 +148,7 @@ where
|
||||
/// Max requests to handle at the same time
|
||||
///
|
||||
/// This depends on the number of active peers but will always be
|
||||
/// [`min_concurrent_requests`..`max_concurrent_requests`]
|
||||
/// `min_concurrent_requests..max_concurrent_requests`
|
||||
#[inline]
|
||||
fn concurrent_request_limit(&self) -> usize {
|
||||
let num_peers = self.client.num_connected_peers();
|
||||
|
||||
@@ -786,9 +786,9 @@ impl NetworkEventStream {
|
||||
peers
|
||||
}
|
||||
|
||||
/// Ensures that the first two events are a [`NetworkEvent::Peer(PeerEvent::PeerAdded`] and
|
||||
/// [`NetworkEvent::ActivePeerSession`], returning the [`PeerId`] of the established
|
||||
/// session.
|
||||
/// Ensures that the first two events are a [`NetworkEvent::Peer`] and
|
||||
/// [`PeerEvent::PeerAdded`][`NetworkEvent::ActivePeerSession`], returning the [`PeerId`] of the
|
||||
/// established session.
|
||||
pub async fn peer_added_and_established(&mut self) -> Option<PeerId> {
|
||||
let peer_id = match self.inner.next().await {
|
||||
Some(NetworkEvent::Peer(PeerEvent::PeerAdded(peer_id))) => peer_id,
|
||||
|
||||
@@ -61,8 +61,8 @@ pub struct PruningArgs {
|
||||
pub receipts_before: Option<BlockNumber>,
|
||||
// Receipts Log Filter
|
||||
/// Configure receipts log filter. Format:
|
||||
/// <`address`>:<`prune_mode`>[,<`address`>:<`prune_mode`>...] Where <`prune_mode`> can be
|
||||
/// 'full', 'distance:<`blocks`>', or 'before:<`block_number`>'
|
||||
/// <`address`>:<`prune_mode`>... where <`prune_mode`> can be 'full', 'distance:<`blocks`>', or
|
||||
/// 'before:<`block_number`>'
|
||||
#[arg(long = "prune.receiptslogfilter", value_name = "FILTER_CONFIG", conflicts_with_all = &["receipts_full", "receipts_pre_merge", "receipts_distance", "receipts_before"], value_parser = parse_receipts_log_filter)]
|
||||
pub receipts_log_filter: Option<ReceiptsLogPruneConfig>,
|
||||
|
||||
|
||||
@@ -156,9 +156,9 @@ impl PruneModes {
|
||||
/// left in database after the pruning.
|
||||
///
|
||||
/// 1. For [`PruneMode::Full`], it fails if `MIN_BLOCKS > 0`.
|
||||
/// 2. For [`PruneMode::Distance(distance`)], it fails if `distance < MIN_BLOCKS + 1`. `+ 1` is
|
||||
/// needed because `PruneMode::Distance(0)` means that we leave zero blocks from the latest,
|
||||
/// meaning we have one block in the database.
|
||||
/// 2. For [`PruneMode::Distance`], it fails if `distance < MIN_BLOCKS + 1`. `+ 1` is needed because
|
||||
/// `PruneMode::Distance(0)` means that we leave zero blocks from the latest, meaning we have one
|
||||
/// block in the database.
|
||||
#[cfg(any(test, feature = "serde"))]
|
||||
fn deserialize_opt_prune_mode_with_min_blocks<
|
||||
'de,
|
||||
|
||||
@@ -25,7 +25,7 @@ pub struct RpcTestCase {
|
||||
/// Action that runs RPC compatibility tests from execution-apis test data
|
||||
#[derive(Debug)]
|
||||
pub struct RunRpcCompatTests {
|
||||
/// RPC methods to test (e.g., ["`eth_getLogs`"])
|
||||
/// RPC methods to test (e.g. `eth_getLogs`)
|
||||
pub methods: Vec<String>,
|
||||
/// Path to the execution-apis tests directory
|
||||
pub test_data_path: String,
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
//! MDBX implementation for reth's database abstraction layer.
|
||||
//!
|
||||
//! This crate is an implementation of [`reth-db-api`] for MDBX, as well as a few other common
|
||||
//! This crate is an implementation of `reth-db-api` for MDBX, as well as a few other common
|
||||
//! database types.
|
||||
//!
|
||||
//! # Overview
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
//! An integration of [`reth-trie`] with [`reth-db`].
|
||||
//! An integration of `reth-trie` with `reth-db`.
|
||||
|
||||
#![cfg_attr(not(test), warn(unused_crate_dependencies))]
|
||||
|
||||
|
||||
@@ -736,7 +736,7 @@ Pruning:
|
||||
Prune receipts before the specified block number. The specified block number is not pruned
|
||||
|
||||
--prune.receiptslogfilter <FILTER_CONFIG>
|
||||
Configure receipts log filter. Format: <`address`>:<`prune_mode`>[,<`address`>:<`prune_mode`>...] Where <`prune_mode`> can be 'full', 'distance:<`blocks`>', or 'before:<`block_number`>'
|
||||
Configure receipts log filter. Format: <`address`>:<`prune_mode`>... where <`prune_mode`> can be 'full', 'distance:<`blocks`>', or 'before:<`block_number`>'
|
||||
|
||||
--prune.accounthistory.full
|
||||
Prunes all account history
|
||||
|
||||
Reference in New Issue
Block a user