We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
1 parent cc3ef96 commit e5ea993Copy full SHA for e5ea993
1 file changed
consensus/src/lib.rs
@@ -196,10 +196,9 @@ stability_scope!(BETA, cfg(not(target_arch = "wasm32")) {
196
197
/// Broadcast a payload to the given recipients.
198
///
199
- /// Returns `true` when the relay has durably handled the payload (per
200
- /// the plan's requirements, e.g. local persistence for `Propose`).
201
- /// Returns `false` when the relay could not complete the handoff,
202
- /// which consensus treats as a fatal condition for the round.
+ /// Returns `true` when the relay accepted the payload for the requested
+ /// broadcast plan. Returns `false` when the relay could not complete the
+ /// handoff.
203
fn broadcast(
204
&mut self,
205
payload: Self::Digest,
0 commit comments