Author: bugman
Date: Sat Mar 22 23:12:10 2008
New Revision: 5160
URL: http://svn.gna.org/viewcvs/relax?rev=5160&view=rev
Log:
Replaced all '@type return:' with '@rtype:' in the docstrings.
Modified:
1.3/generic_fns/align_tensor.py
1.3/generic_fns/diffusion_tensor.py
1.3/generic_fns/minimise.py
1.3/generic_fns/pipes.py
1.3/generic_fns/selection.py
1.3/maths_fns/n_state_model.py
1.3/relax_io.py
1.3/specific_fns/relax_data.py
Modified: 1.3/generic_fns/align_tensor.py
URL:
http://svn.gna.org/viewcvs/relax/1.3/generic_fns/align_tensor.py?rev=5160&r1=5159&r2=5160&view=diff
==============================================================================
--- 1.3/generic_fns/align_tensor.py (original)
+++ 1.3/generic_fns/align_tensor.py Sat Mar 22 23:12:10 2008
@@ -44,7 +44,7 @@
@param pipe: The data pipe to search for data in.
@type pipe: str
@return: The answer to the question.
- @type return: bool
+ @rtype: bool
"""
# The data pipe to check.
@@ -810,7 +810,7 @@
@param param: The parameter name.
@type param: str
@return: The conversion factor.
- @type return: float
+ @rtype: float
"""
# Get the object name.
@@ -999,7 +999,7 @@
@param param: The parameter name.
@type param: str
@return: The string representation of the units.
- @type return: str
+ @rtype: str
"""
# Get the object name.
Modified: 1.3/generic_fns/diffusion_tensor.py
URL:
http://svn.gna.org/viewcvs/relax/1.3/generic_fns/diffusion_tensor.py?rev=5160&r1=5159&r2=5160&view=diff
==============================================================================
--- 1.3/generic_fns/diffusion_tensor.py (original)
+++ 1.3/generic_fns/diffusion_tensor.py Sat Mar 22 23:12:10 2008
@@ -161,7 +161,7 @@
@param pipe: The data pipe to search for data in.
@type pipe: str
@return: The answer to the question.
- @type return: bool
+ @rtype: bool
"""
# The data pipe to check.
Modified: 1.3/generic_fns/minimise.py
URL:
http://svn.gna.org/viewcvs/relax/1.3/generic_fns/minimise.py?rev=5160&r1=5159&r2=5160&view=diff
==============================================================================
--- 1.3/generic_fns/minimise.py (original)
+++ 1.3/generic_fns/minimise.py Sat Mar 22 23:12:10 2008
@@ -242,7 +242,7 @@
@param stat_type: The name of the statistic. This is unused!
@type stat_type: str
@return: A conversion factor of 1.0.
- @type return: float
+ @rtype: float
"""
return 1.0
@@ -299,7 +299,7 @@
@param stat_type: The name of the statistic to return the Grace string
for.
@type stat_type: str
@return: The Grace string.
- @type return: str
+ @rtype: str
"""
# Get the object name.
@@ -335,7 +335,7 @@
@param stat_type: The name of the statistic. This is unused!
@type stat_type: str
@return: Nothing.
- @type return: None
+ @rtype: None
"""
return None
Modified: 1.3/generic_fns/pipes.py
URL:
http://svn.gna.org/viewcvs/relax/1.3/generic_fns/pipes.py?rev=5160&r1=5159&r2=5160&view=diff
==============================================================================
--- 1.3/generic_fns/pipes.py (original)
+++ 1.3/generic_fns/pipes.py Sat Mar 22 23:12:10 2008
@@ -99,7 +99,7 @@
"""Return the name of the current data pipe.
@return: The name of the current data pipe.
- @type return: str
+ @rtype: str
"""
return relax_data_store.current_pipe
Modified: 1.3/generic_fns/selection.py
URL:
http://svn.gna.org/viewcvs/relax/1.3/generic_fns/selection.py?rev=5160&r1=5159&r2=5160&view=diff
==============================================================================
--- 1.3/generic_fns/selection.py (original)
+++ 1.3/generic_fns/selection.py Sat Mar 22 23:12:10 2008
@@ -498,7 +498,7 @@
@param spin_num_col: The column containing the spin number
information.
@type spin_num_col: int or None
@return: The spin identification string.
- @type return: str
+ @rtype: str
"""
# Init.
Modified: 1.3/maths_fns/n_state_model.py
URL:
http://svn.gna.org/viewcvs/relax/1.3/maths_fns/n_state_model.py?rev=5160&r1=5159&r2=5160&view=diff
==============================================================================
--- 1.3/maths_fns/n_state_model.py (original)
+++ 1.3/maths_fns/n_state_model.py Sat Mar 22 23:12:10 2008
@@ -86,7 +86,7 @@
@param params: The vector of parameter values.
@type params: list of float
@return: The chi-squared or SSE value.
- @type return: float
+ @rtype: float
"""
# Reset the back-calculated the reduced tensor structure.
Modified: 1.3/relax_io.py
URL:
http://svn.gna.org/viewcvs/relax/1.3/relax_io.py?rev=5160&r1=5159&r2=5160&view=diff
==============================================================================
--- 1.3/relax_io.py (original)
+++ 1.3/relax_io.py Sat Mar 22 23:12:10 2008
@@ -66,7 +66,7 @@
@return: A tuple of the compression type and full path of the
file (including its
extension). A value of 0 corresponds to no
compression. Bzip2 compression
corresponds to a value of 1. Gzip compression
corresponds to a value of 2.
- @type return: (int, str)
+ @rtype: (int, str)
"""
# The file has been supplied without its compression extension.
@@ -111,7 +111,7 @@
whitespace is assumed.
@type sep: str
@return: The file data.
- @type return: list of lists of str
+ @rtype: list of lists of str
"""
# Data not already extracted from the file.
@@ -146,7 +146,7 @@
assumed.
@type dir: str
@return: The full file path.
- @type return: str
+ @rtype: str
"""
# File name.
@@ -226,7 +226,7 @@
@param verbosity: The verbosity level.
@type verbosity: int
@return: The open file object.
- @type return: file object
+ @rtype: file object
"""
# A file descriptor object.
Modified: 1.3/specific_fns/relax_data.py
URL:
http://svn.gna.org/viewcvs/relax/1.3/specific_fns/relax_data.py?rev=5160&r1=5159&r2=5160&view=diff
==============================================================================
--- 1.3/specific_fns/relax_data.py (original)
+++ 1.3/specific_fns/relax_data.py Sat Mar 22 23:12:10 2008
@@ -491,7 +491,7 @@
@type frq_label: str
@return: The index corresponding to the relaxation data.
If there is no
relaxation data corresponding to the labels,
None is returned.
- @type return: None or int
+ @rtype: None or int
"""
# No data.num_ri data structure.
@@ -673,7 +673,7 @@
@return: The answer to the question of whether relaxation
data exists corresponding to
the given labels.
- @type return: bool
+ @rtype: bool
"""
# Loop over the spins.
r5160 - in /1.3: ./ generic_fns/ maths_fns/ specific_fns/