changeset 1318:e883085a091a tooling/benchmarks

Improve docstring for run_benchmark(target,baseline)
author Jonatan Werpers <jonatan@werpers.com>
date Fri, 28 Apr 2023 08:35:37 +0200
parents 7110851b9c87
children cb4d57ce2ed1
files benchmark/benchmark_utils.jl
diffstat 1 files changed, 3 insertions(+), 2 deletions(-) [+]
line wrap: on
line diff
--- a/benchmark/benchmark_utils.jl	Fri Apr 28 08:34:50 2023 +0200
+++ b/benchmark/benchmark_utils.jl	Fri Apr 28 08:35:37 2023 +0200
@@ -53,8 +53,9 @@
 """
     run_benchmark(target, baseline, f=minimum; judgekwargs=Dict())
 
-Runs the benchmark at revisions `target` and `baseline` and compares them using `PkgBenchmark.judge`.
-`f` is the function used to compare. `judgekwargs` are keyword arguments passed to `judge`.
+Runs the benchmark at revisions `target` and `baseline` and compares them
+using `PkgBenchmark.judge`. `f` is the function used to compare. `judgekwargs`
+are keyword arguments passed to `judge`.
 
 `target` and `baseline` can be any identifier compatible with `hg update`.