Skip to content

Commit

Permalink
update comments for readability
Browse files Browse the repository at this point in the history
  • Loading branch information
soooch authored Apr 23, 2024
1 parent 501689c commit 43d6812
Showing 1 changed file with 4 additions and 5 deletions.
9 changes: 4 additions & 5 deletions benches/bench.rs
Original file line number Diff line number Diff line change
Expand Up @@ -125,15 +125,14 @@ mod future_group {
group.finish();
}

/// This benchmark aims to measure how long it takes for the results of
/// futures that have become ready to be produced by the [`FutureGroup`]
/// stream.
/// This benchmark measures the latency between when futures become ready
/// and when their outputs appear on the [`FutureGroup`] stream.
///
/// To test this, we:
/// - insert N pending futures to the [`FutureGroup`].
/// - until the [`FutureGroup`] is empty, we set some fraction of the
/// pending futures to ready, then record how long it takes for all newly
/// ready futures to be produced from [`FutureGroup`]'s `Stream` impl.
/// pending futures to ready, then record how long it takes for their
/// outputs to be produced from [`FutureGroup`]'s `Stream` impl.
/// - we sum the recorded durations for each of these rounds.
fn future_group_latency_bench(c: &mut Criterion) {
#[derive(Debug, Clone, Copy)]
Expand Down

0 comments on commit 43d6812

Please sign in to comment.