From 0600d57a10c47597295a331b33568a8908b9532d Mon Sep 17 00:00:00 2001 From: victor Date: Fri, 2 Jan 2026 11:08:46 +0100 Subject: [PATCH] fix small typo in `TruncationByValue` and related docstrings --- src/interface/truncation.jl | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/interface/truncation.jl b/src/interface/truncation.jl index a1e993de..26141cc1 100644 --- a/src/interface/truncation.jl +++ b/src/interface/truncation.jl @@ -135,7 +135,7 @@ truncfilter(f) = TruncationByFilter(f) """ TruncationByValue(atol::Real, rtol::Real, p::Real, by, keep_below::Bool=false) -Truncation strategy to keep the values that satisfy `by(val) > max(atol, rtol * norm(values, p)`. +Truncation strategy to keep the values that satisfy `by(val) > max(atol, rtol * norm(values, p))`. If `keep_below = true`, discard these values instead. See also [`trunctol`](@ref) """ @@ -153,7 +153,7 @@ end """ trunctol(; atol::Real=0, rtol::Real=0, p::Real=2, by=abs, keep_below::Bool=false) -Truncation strategy to keep the values that satisfy `by(val) > max(atol, rtol * norm(values, p)`. +Truncation strategy to keep the values that satisfy `by(val) > max(atol, rtol * norm(values, p))`. If `keep_below = true`, discard these values instead. """ function trunctol(; atol::Real = 0, rtol::Real = 0, p::Real = 2, by = abs, keep_below::Bool = false)