Skip to content

Commit

Permalink
add link to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
baggepinnen committed Aug 21, 2024
1 parent e5eabd3 commit 406999b
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion src/MonteCarloMeasurements.jl
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,8 @@ Toggle the use of a comparison function without warning. By default `mean` is us
unsafe_comparisons(mode=:reduction; verbose=true)
One can also specify a comparison mode, `mode` can take the values `:safe, :montecarlo, :reduction`. `:safe` is the same as calling `unsafe_comparisons(false)` and `:reduction` corresponds to `true`.
If
See [Documentation: Comparison mode](https://baggepinnen.github.io/MonteCarloMeasurements.jl/stable/#Comparison-mode-1) for more details.
"""
function unsafe_comparisons(mode=true; verbose=true)
mode == false && (mode = :safe)
Expand Down

0 comments on commit 406999b

Please sign in to comment.