Skip to content

Commit 4fe0fe1

Browse files
committed
docstring improvements
1 parent 35af44d commit 4fe0fe1

1 file changed

Lines changed: 8 additions & 8 deletions

File tree

src/interface/decompositions.jl

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Algorithm type to denote the standard LAPACK algorithm for computing the QR deco
1616
a matrix using Householder reflectors. The specific LAPACK function can be controlled using
1717
the keyword arugments, i.e. `?geqrt` will be chosen if `blocksize > 1`. With
1818
`blocksize == 1`, `?geqrf` will be chosen if `pivoted == false` and `?geqp3` will be chosen
19-
if `pivoted == true`. The keyword `positive=true` can be used to ensure that the diagonal
19+
if `pivoted == true`. The keyword `positive = true` can be used to ensure that the diagonal
2020
elements of `R` are non-negative.
2121
"""
2222
@algdef LAPACK_HouseholderQR
@@ -27,17 +27,17 @@ elements of `R` are non-negative.
2727
Algorithm type to denote the standard LAPACK algorithm for computing the LQ decomposition of
2828
a matrix using Householder reflectors. The specific LAPACK function can be controlled using
2929
the keyword arugments, i.e. `?gelqt` will be chosen if `blocksize > 1` or `?gelqf` will be
30-
chosen if `blocksize == 1`. The keyword `positive=true` can be used to ensure that the diagonal
30+
chosen if `blocksize == 1`. The keyword `positive = true` can be used to ensure that the diagonal
3131
elements of `L` are non-negative.
3232
"""
3333
@algdef LAPACK_HouseholderLQ
3434

3535
"""
3636
GLA_HouseholderQR(; positive = false)
3737
38-
Algorithm type to denote the GenericLinearAlgebra.jl implementation for computing the QR decomposition
39-
of a matrix using Householder reflectors. Currenlty, only `blocksize = 1` and `pivoted == false`
40-
are supported. The keyword `positive=true` can be used to ensure that the diagonal elements
38+
Algorithm type to denote the GenericLinearAlgebra.jl implementation for computing the QR decomposition
39+
of a matrix using Householder reflectors. Currently, only `blocksize = 1` and `pivoted == false`
40+
are supported. The keyword `positive = true` can be used to ensure that the diagonal elements
4141
of `R` are non-negative.
4242
"""
4343
@algdef GLA_HouseholderQR
@@ -69,7 +69,7 @@ const LAPACK_EigAlgorithm = Union{LAPACK_Simple, LAPACK_Expert}
6969
"""
7070
GS_QRIteration()
7171
72-
Algorithm type to denote the GenericSchur.jl implementation for computing the
72+
Algorithm type to denote the GenericSchur.jl implementation for computing the
7373
eigenvalue decomposition of a non-Hermitian matrix.
7474
"""
7575
@algdef GS_QRIteration
@@ -121,8 +121,8 @@ const LAPACK_EighAlgorithm = Union{
121121
"""
122122
GLA_QRIteration()
123123
124-
Algorithm type to denote the GenericLinearAlgebra.jl implementation for computing the
125-
eigenvalue decomposition of a Hermitian matrix, or the singular value decomposition of
124+
Algorithm type to denote the GenericLinearAlgebra.jl implementation for computing the
125+
eigenvalue decomposition of a Hermitian matrix, or the singular value decomposition of
126126
a general matrix.
127127
"""
128128
@algdef GLA_QRIteration

0 commit comments

Comments
 (0)