Skip to content

Commit

Permalink
fix: correct grammatical errors in documentation comments across mult…
Browse files Browse the repository at this point in the history
…iple files
  • Loading branch information
tiendn committed Jan 13, 2025
1 parent 6f7c445 commit e956467
Show file tree
Hide file tree
Showing 6 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion crates/exex/exex/src/manager.rs
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ struct ExExMetrics {

/// A handle to an `ExEx` used by the [`ExExManager`] to communicate with `ExEx`'s.
///
/// A handle should be created for each `ExEx` with a unique ID. The channels returned by
/// A handle should be created for each `ExEx` with an unique ID. The channels returned by
/// [`ExExHandle::new`] should be given to the `ExEx`, while the handle itself should be given to
/// the manager in [`ExExManager::new`].
#[derive(Debug)]
Expand Down
2 changes: 1 addition & 1 deletion crates/net/discv4/src/error.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
use tokio::sync::{mpsc::error::SendError, oneshot::error::RecvError};

/// Error thrown when decoding a UDP packet.
/// Error thrown when decoding an UDP packet.
#[derive(Debug, thiserror::Error)]
pub enum DecodePacketError {
/// Failed to RLP decode the packet.
Expand Down
2 changes: 1 addition & 1 deletion crates/net/discv5/src/metrics.rs
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ pub struct DiscoveredPeersMetrics {
kbucket_peers_raw_total: Gauge,
/// Total discovered peers that are inserted into [`discv5::Discv5`]'s kbuckets.
///
/// This is a subset of the total established sessions, in which all peers advertise a udp
/// This is a subset of the total established sessions, in which all peers advertise an udp
/// socket in their node record which is reachable from the local node. Only these peers make
/// it into [`discv5::Discv5`]'s kbuckets and will hence be included in queries.
///
Expand Down
2 changes: 1 addition & 1 deletion crates/net/network/src/transactions/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -274,7 +274,7 @@ pub struct TransactionsManager<Pool, N: NetworkPrimitives = EthNetworkPrimitives
command_tx: mpsc::UnboundedSender<TransactionsCommand<N>>,
/// Incoming commands from [`TransactionsHandle`].
///
/// This will only receive commands if a user manually sends a command to the manager through
/// This will only receive commands if an user manually sends a command to the manager through
/// the [`TransactionsHandle`] to interact with this type directly.
command_rx: UnboundedReceiverStream<TransactionsCommand<N>>,
/// A stream that yields new __pending__ transactions.
Expand Down
2 changes: 1 addition & 1 deletion crates/node/core/src/dirs.rs
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ pub trait XdgPath {
fn resolve() -> Option<PathBuf>;
}

/// A wrapper type that either parses a user-given path or defaults to an
/// A wrapper type that either parses an user-given path or defaults to an
/// OS-specific path.
///
/// The [`FromStr`] implementation supports shell expansions and common patterns such as `~` for the
Expand Down
2 changes: 1 addition & 1 deletion crates/node/core/src/utils.rs
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ use std::{
};
use tracing::{debug, info};

/// Parses a user-specified path with support for environment variables and common shorthands (e.g.
/// Parses an user-specified path with support for environment variables and common shorthands (e.g.
/// ~ for the user's home directory).
pub fn parse_path(value: &str) -> Result<PathBuf, shellexpand::LookupError<VarError>> {
shellexpand::full(value).map(|path| PathBuf::from(path.into_owned()))
Expand Down

0 comments on commit e956467

Please sign in to comment.