comparison benchmark/benchmark_utils.jl @ 1305:7894d29ea8fa tooling/benchmarks

Improve docs for run_benchmark(rev)
author Jonatan Werpers <jonatan@werpers.com>
date Wed, 26 Apr 2023 13:08:48 +0200
parents 2d34290fdc58
children c14370f7c731
comparison
equal deleted inserted replaced
1304:37d615522c2f 1305:7894d29ea8fa
36 end 36 end
37 37
38 """ 38 """
39 run_benchmark(rev) 39 run_benchmark(rev)
40 40
41 Updates the repository to the given revison and runs the benchmark suite. When done, updates the repository to the origianl state. 41 Updates the repository to the given revison and runs the benchmark suite. When
42 `rev` can be any identifier compatible with `hg update`. 42 done, reverts the repository to the original state. `rev` can be any
43 identifier compatible with `hg update`.
43 44
44 Returns a `PkgBenchmark.BenchmarkResult` 45 Returns a `PkgBenchmark.BenchmarkResult`
45 """ 46 """
46 function run_benchmark(rev; kwargs...) 47 function run_benchmark(rev; kwargs...)
47 rev_before = hg_rev() 48 rev_before = hg_rev()