r24549 - /trunk/pipe_control/minimise.py -- July 17, 2014 - 14:56

Author: bugman
Date: Thu Jul 17 14:56:24 2014
New Revision: 24549

URL: http://svn.gna.org/viewcvs/relax?rev=24549&view=rev
Log:
Removed the line wrapping in the epydoc parameter section of the optimisation 
function docstrings.

This is for the pipe_control.minimise module.


Modified:
    trunk/pipe_control/minimise.py

Modified: trunk/pipe_control/minimise.py
URL: 
http://svn.gna.org/viewcvs/relax/trunk/pipe_control/minimise.py?rev=24549&r1=24548&r2=24549&view=diff
==============================================================================
--- trunk/pipe_control/minimise.py      (original)
+++ trunk/pipe_control/minimise.py      Thu Jul 17 14:56:24 2014
@@ -34,8 +34,7 @@
 def calc(verbosity=1):
     """Function for calculating the function value.
 
-    @param verbosity:   The amount of information to print.  The higher the 
value, the greater
-                        the verbosity.
+    @param verbosity:   The amount of information to print.  The higher the 
value, the greater the verbosity.
     @type verbosity:    int
     """
 
@@ -86,21 +85,15 @@
 def grid_search(lower=None, upper=None, inc=None, constraints=True, 
verbosity=1):
     """The grid search function.
 
-    @param lower:       The lower bounds of the grid search which must be 
equal to the number of
-                        parameters in the model.
+    @param lower:       The lower bounds of the grid search which must be 
equal to the number of parameters in the model.
     @type lower:        array of numbers
-    @param upper:       The upper bounds of the grid search which must be 
equal to the number of
-                        parameters in the model.
+    @param upper:       The upper bounds of the grid search which must be 
equal to the number of parameters in the model.
     @type upper:        array of numbers
-    @param inc:         The increments for each dimension of the space for 
the grid search.  The
-                        number of elements in the array must equal to the 
number of parameters in
-                        the model.
+    @param inc:         The increments for each dimension of the space for 
the grid search.  The number of elements in the array must equal to the 
number of parameters in the model.
     @type inc:          array of int
-    @param constraints: If True, constraints are applied during the grid 
search (elinating parts of
-                        the grid).  If False, no constraints are used.
+    @param constraints: If True, constraints are applied during the grid 
search (elinating parts of the grid).  If False, no constraints are used.
     @type constraints:  bool
-    @param verbosity:   The amount of information to print.  The higher the 
value, the greater
-                        the verbosity.
+    @param verbosity:   The amount of information to print.  The higher the 
value, the greater the verbosity.
     @type verbosity:    int
     """