small docs fixes

Sacha0 · Feb 3, 2015 · dcd40e9 · dcd40e9
1 parent dcfc3fc
commit dcd40e9
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 7 deletions.
diff --git a/base/linalg/lapack.jl b/base/linalg/lapack.jl
@@ -1745,7 +1745,7 @@ for (posv, potrf, potri, potrs, pstrf, elty, rtyp) in
  @assertargsok
  #info[1]>0 means the leading minor of order info[i] is not positive definite
  #ordinarily, throw Exception here, but return error code here
- #this simplifies isposdef! and factorize!
+ #this simplifies isposdef! and factorize
  return A, info[1]
  end
  # SUBROUTINE DPOTRI( UPLO, N, A, LDA, INFO )

diff --git a/doc/stdlib/linalg.rst b/doc/stdlib/linalg.rst
@@ -37,10 +37,6 @@ Linear algebra functions in Julia are largely implemented by calling functions f
 
  Compute a convenient factorization (including LU, Cholesky, Bunch-Kaufman, LowerTriangular, UpperTriangular) of A, based upon the type of the input matrix. The return value can then be reused for efficient solving of multiple systems. For example: ``A=factorize(A); x=A\\b; y=A\\C``.
 
-.. function:: factorize!(A)
-
- ``factorize!`` is the same as :func:`factorize`, but saves space by overwriting the input ``A``, instead of creating a copy.
-
 .. function:: lu(A) -> L, U, p
 
  Compute the LU factorization of ``A``, such that ``A[p,:] = L*U``.
@@ -675,7 +671,7 @@ BLAS Functions
 
 .. module:: Base.LinAlg.BLAS
 
-This module provides wrappers for some of the BLAS functions for
+:mod:`Base.LinAlg.BLAS` provides wrappers for some of the BLAS functions for
 linear algebra. Those BLAS functions that overwrite one of the input
 arrays have names ending in ``'!'``.
 

diff --git a/doc/stdlib/profile.rst b/doc/stdlib/profile.rst
@@ -16,6 +16,8 @@
 
 .. currentmodule:: Base.Profile
 
+The methods in :mod:`Base.Profile` are not exported and need to be called e.g. as ``Profile.print()``.
+
 .. function:: clear()
 
  Clear any existing backtraces from the internal buffer.

diff --git a/doc/stdlib/test.rst b/doc/stdlib/test.rst
@@ -15,7 +15,7 @@ binary install, you can run the test suite using ``Base.runtests()``.
 .. function:: runtests([tests=["all"] [, numcores=iceil(CPU_CORES/2) ]])
 
  Run the Julia unit tests listed in ``tests``, which can be either a
- string or an array of strings, using ``numcores`` processors.
+ string or an array of strings, using ``numcores`` processors. (not exported)
 
 
 .. module:: Base.Test