From fa7c029b386fef5b4636615b7aed00ded600e3af Mon Sep 17 00:00:00 2001 From: Suchir Kavi Date: Mon, 22 Apr 2024 18:52:11 -0700 Subject: [PATCH] update comments for readability --- benches/bench.rs | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/benches/bench.rs b/benches/bench.rs index 45ce7d0..bf335e8 100644 --- a/benches/bench.rs +++ b/benches/bench.rs @@ -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)]