Skip to content

Commit 24c3759

Browse files
committed
Consistency in docstrings
1 parent d72ce5a commit 24c3759

1 file changed

Lines changed: 3 additions & 2 deletions

File tree

src/interface/truncation.jl

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ end
125125
"""
126126
truncerror(; atol::Real=0, rtol::Real=0, p::Real=2)
127127
128-
Create a truncation strategy for truncating such that the error in the factorization
128+
Truncation strategy for truncating values such that the error in the factorization
129129
is smaller than `max(atol, rtol * norm)`, where the error is determined using the `p`-norm.
130130
"""
131131
function truncerror(; atol::Real=0, rtol::Real=0, p::Real=2)
@@ -135,7 +135,8 @@ end
135135
"""
136136
TruncationIntersection(trunc::TruncationStrategy, truncs::TruncationStrategy...)
137137
138-
Composition of multiple truncation strategies, keeping values common between them.
138+
Truncation strategy that composes multiple truncation strategies, keeping values that are
139+
common between them.
139140
"""
140141
struct TruncationIntersection{T<:Tuple{Vararg{TruncationStrategy}}} <: TruncationStrategy
141142
components::T

0 commit comments

Comments
 (0)