docs: fix doc comment errors (#20728)

This commit is contained in:
Satoshi Nakamoto
2026-01-05 11:53:35 +00:00
committed by GitHub
parent 58b0125784
commit b77898c00d
2 changed files with 4 additions and 4 deletions

View File

@@ -41,9 +41,9 @@ where
/// Attempts to submit a new payload to the engine.
///
/// The `TryFrom` conversion will fail if `execution_outcome.state_root` is `B256::ZERO`,
/// in which case this returns the `parent_hash` instead to drive the chain forward.
/// in which case this method uses the `parent_hash` instead to drive the chain forward.
///
/// Returns the block hash to use for FCU (either the new block or parent).
/// Returns the block hash to use for FCU (either the new block's hash or the parent hash).
async fn submit_new_payload(&self, sequence: &FlashBlockCompleteSequence) -> B256 {
let payload = match P::ExecutionData::try_from(sequence) {
Ok(payload) => payload,

View File

@@ -84,14 +84,14 @@ where
}
}
/// Returns the sender half to the received flashblocks.
/// Returns the sender half for the received flashblocks broadcast channel.
pub const fn flashblocks_broadcaster(
&self,
) -> &tokio::sync::broadcast::Sender<Arc<FlashBlock>> {
&self.received_flashblocks_tx
}
/// Returns the sender half to the flashblock sequence.
/// Returns the sender half for the flashblock sequence broadcast channel.
pub const fn block_sequence_broadcaster(
&self,
) -> &tokio::sync::broadcast::Sender<FlashBlockCompleteSequence> {