[Scipy-svn] r3204 - trunk/Lib/optimize

[scipy-svn@scip...]

Author: dmitrey.kroshko
Date: 2007-07-27 12:19:47 -0500 (Fri, 27 Jul 2007)
New Revision: 3204

Modified:
   trunk/Lib/optimize/tnc.py
Log:
updates in tnc documentation (using restructured text)


Modified: trunk/Lib/optimize/tnc.py
===================================================================
--- trunk/Lib/optimize/tnc.py	2007-07-27 11:31:47 UTC (rev 3203)
+++ trunk/Lib/optimize/tnc.py	2007-07-27 17:19:47 UTC (rev 3204)
@@ -84,9 +84,7 @@
     """Minimize a function with variables subject to bounds, using gradient
     information.
 
-    returns (rc, nfeval, x).
-
-    Inputs:
+    :Parameters:
     func      : the function to minimize. Must take one argument, x and return
                 f and g, where f is the value of the function and g its
                 gradient (a list of floats).
@@ -144,12 +142,13 @@
                 if a large value, never rescale
                 if < 0, rescale is set to 1.3
 
-    Outputs:
+
+    :Returnss:
     x         : the solution
     nfeval    : the number of function evaluations
     rc        : return code as defined in the RCSTRINGS dict
 
-See also:
+    :SeeAlso:
 
   fmin, fmin_powell, fmin_cg,
          fmin_bfgs, fmin_ncg -- multivariate local optimizers