Update docstring for sy/hetrf.

Author: andreasnoack

base/linalg/lapack.jl

@@ -4683,13 +4683,16 @@ factorization.
 sysv!(uplo::Char, A::StridedMatrix, B::StridedVecOrMat)
 
 """
-    sytrf!(uplo, A) -> (A, ipiv)
+    sytrf!(uplo, A) -> (A, ipiv, info)
 
 Computes the Bunch-Kaufman factorization of a symmetric matrix `A`. If
 `uplo = U`, the upper half of `A` is stored. If `uplo = L`, the lower
 half is stored.
 
-Returns `A`, overwritten by the factorization, and a pivot vector `ipiv`.
+Returns `A`, overwritten by the factorization, a pivot vector `ipiv`, and
+the error code `info` which is a non-negative integer. If `info` is positive
+the matrix is singular and the diagonal part of the factorization is exactly
+zero at position `info`.
 """
 sytrf!(uplo::Char, A::StridedMatrix)
 
@@ -4725,13 +4728,16 @@ factorization.
 hesv!(uplo::Char, A::StridedMatrix, B::StridedVecOrMat)
 
 """
-    hetrf!(uplo, A) -> (A, ipiv)
+    hetrf!(uplo, A) -> (A, ipiv, info)
 
 Computes the Bunch-Kaufman factorization of a Hermitian matrix `A`. If
 `uplo = U`, the upper half of `A` is stored. If `uplo = L`, the lower
 half is stored.
 
-Returns `A`, overwritten by the factorization, and a pivot vector.
+Returns `A`, overwritten by the factorization, a pivot vector `ipiv`, and
+the error code `info` which is a non-negative integer. If `info` is positive
+the matrix is singular and the diagonal part of the factorization is exactly
+zero at position `info`.
 """
 hetrf!(uplo::Char, A::StridedMatrix)
 

doc/stdlib/linalg.rst

@@ -2061,13 +2061,13 @@ set of functions in future releases.
 
    Finds the solution to ``A * X = B`` for symmetric matrix ``A``\ . If ``uplo = U``\ , the upper half of ``A`` is stored. If ``uplo = L``\ , the lower half is stored. ``B`` is overwritten by the solution ``X``\ . ``A`` is overwritten by its Bunch-Kaufman factorization. ``ipiv`` contains pivoting information about the factorization.
 
-.. function:: sytrf!(uplo, A) -> (A, ipiv)
+.. function:: sytrf!(uplo, A) -> (A, ipiv, info)
 
    .. Docstring generated from Julia source
 
    Computes the Bunch-Kaufman factorization of a symmetric matrix ``A``\ . If ``uplo = U``\ , the upper half of ``A`` is stored. If ``uplo = L``\ , the lower half is stored.
 
-   Returns ``A``\ , overwritten by the factorization, and a pivot vector ``ipiv``\ .
+   Returns ``A``\ , overwritten by the factorization, a pivot vector ``ipiv``\ , and the error code ``info`` which is a non-negative integer. If ``info`` is positive the matrix is singular and the diagonal part of the factorization is exactly zero at position ``info``
 
 .. function:: sytri!(uplo, A, ipiv)
 
@@ -2087,13 +2087,13 @@ set of functions in future releases.
 
    Finds the solution to ``A * X = B`` for Hermitian matrix ``A``\ . If ``uplo = U``\ , the upper half of ``A`` is stored. If ``uplo = L``\ , the lower half is stored. ``B`` is overwritten by the solution ``X``\ . ``A`` is overwritten by its Bunch-Kaufman factorization. ``ipiv`` contains pivoting information about the factorization.
 
-.. function:: hetrf!(uplo, A) -> (A, ipiv)
+.. function:: hetrf!(uplo, A) -> (A, ipiv, info)
 
    .. Docstring generated from Julia source
 
    Computes the Bunch-Kaufman factorization of a Hermitian matrix ``A``\ . If ``uplo = U``\ , the upper half of ``A`` is stored. If ``uplo = L``\ , the lower half is stored.
 
-   Returns ``A``\ , overwritten by the factorization, and a pivot vector.
+   Returns ``A``\ , overwritten by the factorization, a pivot vector ``ipiv``\ , and the error code ``info`` which is a non-negative integer. If ``info`` is positive the matrix is singular and the diagonal part of the factorization is exactly zero at position ``info``\ .
 
 .. function:: hetri!(uplo, A, ipiv)