[Scipy-svn] r3553 - trunk/scipy/linsolve/umfpack

[scipy-svn at scipy.org]

Author: rc
Date: 2007-11-20 08:28:31 -0600 (Tue, 20 Nov 2007)
New Revision: 3553

Modified:
   trunk/scipy/linsolve/umfpack/info.py
Log:
Edited module docstring.


Modified: trunk/scipy/linsolve/umfpack/info.py
===================================================================
--- trunk/scipy/linsolve/umfpack/info.py	2007-11-20 12:04:20 UTC (rev 3552)
+++ trunk/scipy/linsolve/umfpack/info.py	2007-11-20 14:28:31 UTC (rev 3553)
@@ -2,6 +2,10 @@
 Interface to the UMFPACK library.
 =================================
 
+:Contains: UmfpackContext class
+
+:Description:
+-------------
 Routines for symbolic and numeric LU factorization of sparse
 matrices and for solving systems of linear equations with sparse matrices.
 
@@ -9,13 +13,12 @@
 Copyright (c) 2005 by Timothy A. Davis.  All Rights Reserved.
 UMFPACK homepage: http://www.cise.ufl.edu/research/sparse/umfpack
 
-Contains: UmfpackContext class
-
 Use 'print UmfpackContext().funs' to see all UMFPACK library functions the
 module exposes, if you need something not covered by the examples below.
 
-Installation:
-=============
+:Installation:
+--------------
+
 Example site.cfg entry:
 
 UMFPACK v4.4 in <dir>:
@@ -43,8 +46,8 @@
 umfpack_libs = umfpack
 
 
-Examples:
-=========
+:Examples:
+----------
 
 Assuming this module imported as um (import scipy.linsolve.umfpack as um)
 
@@ -115,8 +118,8 @@
                LU = PRAQ        when do_recip is true
                LU = P(R^-1)AQ   when do_recip is false
 
-Description of arguments of UmfpackContext solution methods:
-=============================================
+:Arguments of UmfpackContext solution methods:
+----------------------------------------------
 This holds for: umfpack(), umfpack.linsolve(), umfpack.solve()
 
  sys - one of UMFPACK system description constants, like
@@ -128,8 +131,9 @@
        transposed type, if 'mtx' is in CSR, since UMFPACK
        assumes CSC internally
 
-Setting control parameters:
-===========================
+:Setting control parameters:
+----------------------------
+
 Assuming this module imported as um:
 
 List of control parameter names is accessible as 'um.umfControls' - their
@@ -143,9 +147,9 @@
 umfpack.control[um.UMFPACK_PRL] = 4 # Let's be more verbose.
 
 --
-Author: Robert Cimrman
+:Author: Robert Cimrman
 
-Other contributors: Nathan Bell (lu() method wrappers)
+:Other contributors: Nathan Bell (lu() method wrappers)
 """
 
 postpone_import = 1