Skip to content

Commit 8bb35d9

Browse files
committed
make trunc kwarg explicit in docstrings
1 parent 5ce6c2c commit 8bb35d9

2 files changed

Lines changed: 4 additions & 4 deletions

File tree

src/interface/eig.jl

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,9 @@ See also [`eig_vals(!)`](@ref eig_vals) and [`eig_trunc(!)`](@ref eig_trunc).
3232
@functiondef eig_full
3333

3434
"""
35-
eig_trunc(A; kwargs...) -> D, V, ϵ
35+
eig_trunc(A; [trunc], kwargs...) -> D, V, ϵ
3636
eig_trunc(A, alg::AbstractAlgorithm) -> D, V, ϵ
37-
eig_trunc!(A, [DV]; kwargs...) -> D, V, ϵ
37+
eig_trunc!(A, [DV]; [trunc], kwargs...) -> D, V, ϵ
3838
eig_trunc!(A, [DV], alg::AbstractAlgorithm) -> D, V, ϵ
3939
4040
Compute a partial or truncated eigenvalue decomposition of the matrix `A`,

src/interface/svd.jl

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,9 +42,9 @@ See also [`svd_full(!)`](@ref svd_full), [`svd_vals(!)`](@ref svd_vals) and
4242
@functiondef svd_compact
4343

4444
"""
45-
svd_trunc(A; kwargs...) -> U, S, Vᴴ, ϵ
45+
svd_trunc(A; [trunc], kwargs...) -> U, S, Vᴴ, ϵ
4646
svd_trunc(A, alg::AbstractAlgorithm) -> U, S, Vᴴ, ϵ
47-
svd_trunc!(A, [USVᴴ]; kwargs...) -> U, S, Vᴴ, ϵ
47+
svd_trunc!(A, [USVᴴ]; [trunc], kwargs...) -> U, S, Vᴴ, ϵ
4848
svd_trunc!(A, [USVᴴ], alg::AbstractAlgorithm) -> U, S, Vᴴ, ϵ
4949
5050
Compute a partial or truncated singular value decomposition (SVD) of `A`, such that

0 commit comments

Comments
 (0)