[Scipy-svn] r2484 - trunk/Lib/linsolve

[scipy-svn at scipy.org]

Author: timl
Date: 2007-01-04 00:03:07 -0600 (Thu, 04 Jan 2007)
New Revision: 2484

Modified:
   trunk/Lib/linsolve/linsolve.py
Log:
update docstring

Modified: trunk/Lib/linsolve/linsolve.py
===================================================================
--- trunk/Lib/linsolve/linsolve.py	2007-01-03 21:31:12 UTC (rev 2483)
+++ trunk/Lib/linsolve/linsolve.py	2007-01-04 06:03:07 UTC (rev 2484)
@@ -87,8 +87,12 @@
 def splu(A, permc_spec=2, diag_pivot_thresh=1.0,
          drop_tol=0.0, relax=1, panel_size=10):
     """
-    A linear solver, for a square matrix A, using LU decomposition where
+    A linear solver, for a sparse, square matrix A, using LU decomposition where
     L is a lower triangular matrix and U is an upper triagular matrix.
+
+    Returns a factored_lu object. (scipy.linsolve._superly.SciPyLUType)
+
+    See scipy.linsolve._superlu.dgstrf for more info.
     """
     M, N = A.shape
     if (M != N):