Author: bugman
Date: Thu Jul 17 17:24:09 2014
New Revision: 24558
URL: http://svn.gna.org/viewcvs/relax?rev=24558&view=rev
Log:
Fix for a number of docstring typos from r24557.
Modified:
branches/zooming_grid_search/specific_analyses/api_common.py
branches/zooming_grid_search/specific_analyses/consistency_tests/api.py
branches/zooming_grid_search/specific_analyses/jw_mapping/api.py
Modified: branches/zooming_grid_search/specific_analyses/api_common.py
URL:
http://svn.gna.org/viewcvs/relax/branches/zooming_grid_search/specific_analyses/api_common.py?rev=24558&r1=24557&r2=24558&view=diff
==============================================================================
--- branches/zooming_grid_search/specific_analyses/api_common.py
(original)
+++ branches/zooming_grid_search/specific_analyses/api_common.py Thu
Jul 17 17:24:09 2014
@@ -93,7 +93,7 @@
def _data_init_spin(self, model_info, sim=False):
"""Initialise data structures (spin system specific).
- @param model_info: The spin container and the spin ID string from
the _model_info_spin() method.
+ @param model_info: The spin container and the spin ID string from
the _model_loop_spin() method.
@type model_info: SpinContainer instance, str
@keyword sim: The Monte Carlo simulation flag, which if true
will initialise the simulation data structure.
@type sim: bool
@@ -483,7 +483,7 @@
def _set_error_spin(self, model_info, index, error):
"""Set the parameter errors (spin system specific).
- @param model_info: The spin container and the spin ID string from
the _model_info_spin() method.
+ @param model_info: The spin container and the spin ID string from
the _model_loop_spin() method.
@type model_info: SpinContainer instance, str
@param index: The index of the parameter to set the errors for.
@type index: int
@@ -614,7 +614,7 @@
def _set_selected_sim_spin(self, model_info, select_sim):
"""Set the simulation selection flag (spin system specific).
- @param model_info: The spin container and the spin ID string from
the _model_info_spin() method.
+ @param model_info: The spin container and the spin ID string from
the _model_loop_spin() method.
@type model_info: SpinContainer instance, str
@param select_sim: The selection flag for the simulations.
@type select_sim: bool
@@ -739,7 +739,7 @@
def _sim_return_chi2_spin(self, model_info, index=None):
"""Return the simulation chi-squared values (spin system specific).
- @param model_info: The spin container and the spin ID string from
the _model_info_spin() method.
+ @param model_info: The spin container and the spin ID string from
the _model_loop_spin() method.
@type model_info: SpinContainer instance, str
@keyword index: The optional simulation index.
@type index: int
@@ -762,7 +762,7 @@
def _sim_return_param_spin(self, model_info, index):
"""Return the array of simulation parameter values (spin system
specific).
- @param model_info: The spin container and the spin ID string from
the _model_info_spin() method.
+ @param model_info: The spin container and the spin ID string from
the _model_loop_spin() method.
@type model_info: SpinContainer instance, str
@param index: The index of the parameter to return the array
of values for.
@type index: int
@@ -806,7 +806,7 @@
def _sim_return_selected_spin(self, model_info):
"""Return the array of selected simulation flags (spin system
specific).
- @param model_info: The spin container and the spin ID string from
the _model_info_spin() method.
+ @param model_info: The spin container and the spin ID string from
the _model_loop_spin() method.
@type model_info: SpinContainer instance, str
@return: The array of selected simulation flags.
@rtype: list of int
Modified:
branches/zooming_grid_search/specific_analyses/consistency_tests/api.py
URL:
http://svn.gna.org/viewcvs/relax/branches/zooming_grid_search/specific_analyses/consistency_tests/api.py?rev=24558&r1=24557&r2=24558&view=diff
==============================================================================
--- branches/zooming_grid_search/specific_analyses/consistency_tests/api.py
(original)
+++ branches/zooming_grid_search/specific_analyses/consistency_tests/api.py
Thu Jul 17 17:24:09 2014
@@ -348,7 +348,7 @@
def set_error(self, model_info, index, error):
"""Set the parameter errors.
- @param model_info: The spin container and the spin ID string from
the _model_info_spin() method.
+ @param model_info: The spin container and the spin ID string from
the _model_loop_spin() method.
@type model_info: SpinContainer instance, str
@param index: The index of the parameter to set the errors for.
@type index: int
@@ -375,7 +375,7 @@
def sim_return_param(self, model_info, index):
"""Return the array of simulation parameter values.
- @param model_info: The spin container and the spin ID string from
the _model_info_spin() method.
+ @param model_info: The spin container and the spin ID string from
the _model_loop_spin() method.
@type model_info: SpinContainer instance, str
@param index: The index of the parameter to return the array
of values for.
@type index: int
@@ -406,7 +406,7 @@
def sim_return_selected(self, model_info):
"""Return the array of selected simulation flags.
- @param model_info: The spin container and the spin ID string from
the _model_info_spin() method.
+ @param model_info: The spin container and the spin ID string from
the _model_loop_spin() method.
@type model_info: SpinContainer instance, str
@return: The array of selected simulation flags.
@rtype: list of int
Modified: branches/zooming_grid_search/specific_analyses/jw_mapping/api.py
URL:
http://svn.gna.org/viewcvs/relax/branches/zooming_grid_search/specific_analyses/jw_mapping/api.py?rev=24558&r1=24557&r2=24558&view=diff
==============================================================================
--- branches/zooming_grid_search/specific_analyses/jw_mapping/api.py
(original)
+++ branches/zooming_grid_search/specific_analyses/jw_mapping/api.py Thu
Jul 17 17:24:09 2014
@@ -339,7 +339,7 @@
def set_error(self, model_info, index, error):
"""Set the parameter errors.
- @param model_info: The spin container and the spin ID string from
the _model_info_spin() method.
+ @param model_info: The spin container and the spin ID string from
the _model_loop_spin() method.
@type model_info: SpinContainer instance, str
@param index: The index of the parameter to set the errors for.
@type index: int
@@ -366,7 +366,7 @@
def sim_return_param(self, model_info, index):
"""Return the array of simulation parameter values.
- @param model_info: The spin container and the spin ID string from
the _model_info_spin() method.
+ @param model_info: The spin container and the spin ID string from
the _model_loop_spin() method.
@type model_info: SpinContainer instance, str
@param index: The index of the parameter to return the array
of values for.
@type index: int
@@ -397,7 +397,7 @@
def sim_return_selected(self, model_info):
"""Return the array of selected simulation flags.
- @param model_info: The spin container and the spin ID string from
the _model_info_spin() method.
+ @param model_info: The spin container and the spin ID string from
the _model_loop_spin() method.
@type model_info: SpinContainer instance, str
@return: The array of selected simulation flags.
@rtype: list of int
r24558 - in /branches/zooming_grid_search/specific_analyses: api_common.py consistency_tests/api.py jw_mapping/api.py