Skip to content

Commit

Permalink
Update the docstring for export_markdown
Browse files Browse the repository at this point in the history
  • Loading branch information
DilumAluthge committed Aug 20, 2019
1 parent fca7642 commit 1f9a87e
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions src/benchmarkresults.jl
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down

0 comments on commit 1f9a87e

Please sign in to comment.