From 1f9a87eba01bae08cd34d83383b49e9354275a1c Mon Sep 17 00:00:00 2001 From: Dilum Aluthge Date: Tue, 20 Aug 2019 00:00:27 -0400 Subject: [PATCH] Update the docstring for `export_markdown` --- src/benchmarkresults.jl | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/src/benchmarkresults.jl b/src/benchmarkresults.jl index af6a411..b376115 100644 --- a/src/benchmarkresults.jl +++ b/src/benchmarkresults.jl @@ -85,11 +85,17 @@ function readresults(file::String) end """ - export_markdown(file::String, results::Union{BenchmarkResults, BenchmarkJudgement}) - export_markdown(io::IO, results::Union{BenchmarkResults, BenchmarkJudgement}) + export_markdown(file::String, results::BenchmarkResults) + export_markdown(io::IO, results::BenchmarkResults) + export_markdown(file::String, results::BenchmarkJudgement; export_invariants=false) + export_markdown(io::IO, results::BenchmarkJudgement; export_invariants=false) Writes the `results` to `file` or `io` in markdown format. +When exporting a `BenchmarkJudgement`, by default only the results corresponding to +possible regressions or improvements will be included. To also export the invariant +results, set `export_invariants=true`. + See also: [`BenchmarkResults`](@ref), [`BenchmarkJudgement`](@ref) """ function export_markdown(file::String, results::BenchmarkResults)