search

bheisler / criterion.rs

Statistics-driven benchmarking library for Rust
Apache License 2.0
4.31k stars 292 forks source link

docs: Fix comments to say clone not to_vec (#715) #716

Closed jkugelman closed 7 months ago

jkugelman commented 11 months ago

In bencher.rs there are four doc comments like this:

/// c.bench_function("with_setup", move |b| {
///     // This will avoid timing the to_vec call.
///     b.iter_batched(|| data.clone(), /* ... */)
/// });

They should say clone not to_vec because the setup code is || data.clone().

waywardmonkeys commented 9 months ago

@jkugelman Could you rebase this forward so that CI can pass?

jkugelman commented 9 months ago

@waywardmonkeys Done.

waywardmonkeys commented 9 months ago

@jkugelman Thanks. Up to @lemmih now!