From dd8bf6bbc6c28f22f845b3185ea381413606edd8 Mon Sep 17 00:00:00 2001 From: Clark Date: Fri, 15 Nov 2024 09:20:25 -0400 Subject: [PATCH] add docstring to `judge` --- src/trials.jl | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/src/trials.jl b/src/trials.jl index 67382813..eed19f6f 100644 --- a/src/trials.jl +++ b/src/trials.jl @@ -218,8 +218,17 @@ memory(t::TrialJudgement) = t.memory ratio(t::TrialJudgement) = t.ratio params(t::TrialJudgement) = params(ratio(t)) +""" + judge(a::TrialEstimate, b::TrialEstimate; [time_tolerance::Float64=0.05]) + judge(groups::BenchmarkGroup..., [time_tolerance::Float64=0.05]) + +Report if the estimate passed as first argument represents a regression versus the second estimate. +""" judge(a::TrialEstimate, b::TrialEstimate; kwargs...) = judge(ratio(a, b); kwargs...) +""" + judge(r::TrialRatio, [time_tolerance::Float64=0.05]) +""" function judge(r::TrialRatio; kwargs...) newr = copy(r) newr.params = Parameters(params(r); kwargs...)