docs: fix article and grammar errors in comments (#20794)

This commit is contained in:
Mohan Somnath
2026-01-07 23:00:13 +08:00
committed by GitHub
parent 8d19a36492
commit 4c064a4d20
6 changed files with 7 additions and 7 deletions

View File

@@ -396,7 +396,7 @@ impl ExecutionOutcome {
/// Returns the ethereum receipt root for all recorded receipts.
///
/// Note: this function calculated Bloom filters for every receipt and created merkle trees
/// of receipt. This is a expensive operation.
/// of receipt. This is an expensive operation.
pub fn ethereum_receipts_root(&self, block_number: BlockNumber) -> Option<B256> {
self.generic_receipts_root_slow(
block_number,

View File

@@ -757,12 +757,12 @@ impl RequestTxHashes {
Self::new(HashSet::with_capacity_and_hasher(capacity, Default::default()))
}
/// Returns an new empty instance.
/// Returns a new empty instance.
fn empty() -> Self {
Self::new(HashSet::default())
}
/// Retains the given number of elements, returning and iterator over the rest.
/// Retains the given number of elements, returning an iterator over the rest.
pub fn retain_count(&mut self, count: usize) -> Self {
let rest_capacity = self.hashes.len().saturating_sub(count);
if rest_capacity == 0 {

View File

@@ -1245,7 +1245,7 @@ pub enum PeerAction {
PeerRemoved(PeerId),
}
/// Error thrown when a incoming connection is rejected right away
/// Error thrown when an incoming connection is rejected right away
#[derive(Debug, Error, PartialEq, Eq)]
pub enum InboundConnectionError {
/// The remote's ip address is banned

View File

@@ -38,7 +38,7 @@ pub enum ProtocolEvent {
},
}
/// Protocol state is an helper struct to store the protocol events.
/// Protocol state is a helper struct to store the protocol events.
#[derive(Clone, Debug)]
pub struct ProtocolState {
/// Protocol event sender.

View File

@@ -878,7 +878,7 @@ pub struct RevertError {
impl RevertError {
/// Wraps the output bytes
///
/// Note: this is intended to wrap an revm output
/// Note: this is intended to wrap a revm output
pub fn new(output: Bytes) -> Self {
if output.is_empty() {
Self { output: None }

View File

@@ -409,7 +409,7 @@ impl<T> MockTransactionValidator<T> {
pub fn no_propagate_local() -> Self {
Self { propagate_local: false, return_invalid: false, _marker: Default::default() }
}
/// Creates a new [`MockTransactionValidator`] that always return a invalid outcome.
/// Creates a new [`MockTransactionValidator`] that always returns an invalid outcome.
pub fn return_invalid() -> Self {
Self { propagate_local: false, return_invalid: true, _marker: Default::default() }
}