Skip to content

fix small typo in TruncationByValue and related docstrings #136

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Jutho merged 1 commit into from
Jan 2, 2026
Merged

fix small typo in TruncationByValue and related docstrings #136

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/interface/truncation.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
"""
Expand All @@ -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)
Expand Down
Loading