docs(payload): fix typos and incorrect references in comments (#20771)

Signed-off-by: Hwangjae Lee <meetrick@gmail.com>
This commit is contained in:
Hwangjae Lee
2026-01-06 18:42:37 +09:00
committed by GitHub
parent 0c6688d056
commit c1ef67df70
4 changed files with 4 additions and 4 deletions

View File

@@ -297,7 +297,7 @@ impl Default for BasicPayloadJobGeneratorConfig {
/// resolved or the deadline is reached, or until the built payload is marked as frozen:
/// [`BuildOutcome::Freeze`]. Once a frozen payload is returned, no additional payloads will be
/// built and this future will wait to be resolved: [`PayloadJob::resolve`] or terminated if the
/// deadline is reached..
/// deadline is reached.
#[derive(Debug)]
pub struct BasicPayloadJob<Tasks, Builder>
where

View File

@@ -2,7 +2,7 @@
use reth_metrics::{metrics::Counter, Metrics};
/// Transaction pool metrics
/// Payload builder metrics
#[derive(Metrics)]
#[metrics(scope = "payloads")]
pub(crate) struct PayloadBuilderMetrics {

View File

@@ -65,7 +65,7 @@ impl PayloadJobGenerator for TestPayloadJobGenerator {
}
}
/// A [`PayloadJobGenerator`] for testing purposes
/// A [`PayloadJob`] for testing purposes
#[derive(Debug)]
pub struct TestPayloadJob {
attr: EthPayloadBuilderAttributes,

View File

@@ -44,7 +44,7 @@ impl<T: Clone> PayloadTransactions for PayloadTransactionsFixed<T> {
/// `PayloadTransactions` iterators and keeps track of the gas for both of iterators.
///
/// We can't use [`Iterator::chain`], because:
/// (a) we need to propagate the `mark_invalid` and `no_updates`
/// (a) we need to propagate the `mark_invalid`
/// (b) we need to keep track of the gas
///
/// Notes that [`PayloadTransactionsChain`] fully drains the first iterator