improved documentation for cholfact!

JuliaLang · May 7, 2016 · 9f727c4 · 9f727c4
1 parent 6616686
commit 9f727c4
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/doc/stdlib/linalg.rst b/doc/stdlib/linalg.rst
@@ -209,13 +209,13 @@ Linear algebra functions in Julia are largely implemented by calling functions f
 
    .. Docstring generated from Julia source
 
-   The same as ``cholfact``\ , but saves space by overwriting the input ``A``\ , instead of creating a copy.
+   The same as ``cholfact``\ , but saves space by overwriting the input ``A``\ , instead of creating a copy. An ``InexactError`` exception is thrown if the factorisation produces a number not representable by the element type of ``A``, e.g. for integer types.
 
 .. function:: cholfact!(A::StridedMatrix, uplo::Symbol, Val{true}) -> PivotedCholesky
 
    .. Docstring generated from Julia source
 
-   The same as ``cholfact``\ , but saves space by overwriting the input ``A``\ , instead of creating a copy.
+   The same as ``cholfact``\ , but saves space by overwriting the input ``A``\ , instead of creating a copy. An ``InexactError`` exception is thrown if the factorisation produces a number not representable by the element type of ``A``, e.g. for integer types.
 
 .. currentmodule:: Base.LinAlg