r24598 - /branches/zooming_grid_search/pipe_control/minimise.py -- July 22, 2014 - 13:11

Author: bugman
Date: Tue Jul 22 13:11:50 2014
New Revision: 24598

URL: http://svn.gna.org/viewcvs/relax?rev=24598&view=rev
Log:
Epydoc docstring fixes for the keyword arguments of the pipe_control.minimise 
module.


Modified:
    branches/zooming_grid_search/pipe_control/minimise.py

Modified: branches/zooming_grid_search/pipe_control/minimise.py
URL: 
http://svn.gna.org/viewcvs/relax/branches/zooming_grid_search/pipe_control/minimise.py?rev=24598&r1=24597&r2=24598&view=diff
==============================================================================
--- branches/zooming_grid_search/pipe_control/minimise.py       (original)
+++ branches/zooming_grid_search/pipe_control/minimise.py       Tue Jul 22 
13:11:50 2014
@@ -86,7 +86,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.
+    @keyword verbosity: The amount of information to print.  The higher the 
value, the greater the verbosity.
     @type verbosity:    int
     """
 
@@ -140,16 +140,16 @@
 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.
-    @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.
-    @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.
-    @type inc:          int or list of int
-    @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.
-    @type verbosity:    int
+    @keyword 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
+    @keyword 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
+    @keyword 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:              int or list of int
+    @keyword constraints:   If True, constraints are applied during the grid 
search (elinating parts of the grid).  If False, no constraints are used.
+    @type constraints:      bool
+    @keyword verbosity:     The amount of information to print.  The higher 
the value, the greater the verbosity.
+    @type verbosity:        int
     """
 
     # Test if the current data pipe exists.
@@ -211,7 +211,7 @@
     @type upper:        list of numbers
     @keyword inc:       The user supplied grid search increments.
     @type inc:          int or list of int
-    @param verbosity:   The amount of information to print.  The higher the 
value, the greater the verbosity.
+    @keyword verbosity: The amount of information to print.  The higher the 
value, the greater the verbosity.
     @type verbosity:    int
     @return:            The per-model grid upper and lower bounds.  The 
first dimension of each structure corresponds to the model, the second the 
model parameters.
     @rtype:             tuple of lists of lists of float, lists of lists of 
float, list of lists of int
@@ -435,9 +435,9 @@
 def reset_min_stats(data_pipe=None, spin=None):
     """Function for resetting the minimisation statistics.
 
-    @param data_pipe:   The name of the data pipe to reset the minimisation 
statisics of.  This defaults to the current data pipe.
+    @keyword data_pipe: The name of the data pipe to reset the minimisation 
statisics of.  This defaults to the current data pipe.
     @type data_pipe:    str
-    @param spin:        The spin data container if spin specific data is to 
be reset.
+    @keyword spin:      The spin data container if spin specific data is to 
be reset.
     @type spin:         SpinContainer
     """