Author: bugman
Date: Wed Oct 22 22:25:33 2008
New Revision: 7937
URL: http://svn.gna.org/viewcvs/relax?rev=7937&view=rev
Log:
Epydoc doctring indentation fixes.
Modified:
1.3/specific_fns/consistency_tests.py
1.3/specific_fns/jw_mapping.py
1.3/specific_fns/model_free/main.py
1.3/specific_fns/relax_fit.py
1.3/test_suite/test_suite_runner.py
Modified: 1.3/specific_fns/consistency_tests.py
URL:
http://svn.gna.org/viewcvs/relax/1.3/specific_fns/consistency_tests.py?rev=7937&r1=7936&r2=7937&view=diff
==============================================================================
--- 1.3/specific_fns/consistency_tests.py (original)
+++ 1.3/specific_fns/consistency_tests.py Wed Oct 22 22:25:33 2008
@@ -204,15 +204,15 @@
The names are as follows:
- r: Bond length.
- csa: CSA value.
- heteronuc_type: The heteronucleus type.
- orientation: Angle between the 15N-1H vector and the principal
axis of the 15N chemical
- shift tensor.
- tc: Correlation time.
- j0: Spectral density value at 0 MHz.
- f_eta: Eta-test (from Fushman D. et al. (1998) JACS, 120:
10947-10952).
- f_r2: R2-test (from Fushman D. et al. (1998) JACS, 120:
10947-10952).
+ - 'r', bond length.
+ - 'csa', CSA value.
+ - 'heteronuc_type', the heteronucleus type.
+ - 'orientation', angle between the 15N-1H vector and the
principal axis of the 15N
+ chemical shift tensor.
+ - 'tc', correlation time.
+ - 'j0', spectral density value at 0 MHz.
+ - 'f_eta', eta-test (from Fushman D. et al. (1998) JACS, 120:
10947-10952).
+ - 'f_r2', R2-test (from Fushman D. et al. (1998) JACS, 120:
10947-10952).
@keyword set: An unused variable.
Modified: 1.3/specific_fns/jw_mapping.py
URL:
http://svn.gna.org/viewcvs/relax/1.3/specific_fns/jw_mapping.py?rev=7937&r1=7936&r2=7937&view=diff
==============================================================================
--- 1.3/specific_fns/jw_mapping.py (original)
+++ 1.3/specific_fns/jw_mapping.py Wed Oct 22 22:25:33 2008
@@ -196,12 +196,12 @@
The names are as follows:
- r: Bond length.
- csa: CSA value.
- heteronuc_type: The heteronucleus type.
- j0: Spectral density value at 0 MHz.
- jwx: Spectral density value at the frequency of the
heteronucleus.
- jwh: Spectral density value at the frequency of the
heteronucleus.
+ - 'r', bond length.
+ - 'csa', CSA value.
+ - 'heteronuc_type', the heteronucleus type.
+ - 'j0', spectral density value at 0 MHz.
+ - 'jwx', spectral density value at the frequency of the
heteronucleus.
+ - 'jwh', spectral density value at the frequency of the
heteronucleus.
@keyword set: An unused variable.
Modified: 1.3/specific_fns/model_free/main.py
URL:
http://svn.gna.org/viewcvs/relax/1.3/specific_fns/model_free/main.py?rev=7937&r1=7936&r2=7937&view=diff
==============================================================================
--- 1.3/specific_fns/model_free/main.py (original)
+++ 1.3/specific_fns/model_free/main.py Wed Oct 22 22:25:33 2008
@@ -659,26 +659,26 @@
The names are as follows:
- model: The model-free model name.
- equation: The model-free equation type.
- params: An array of the model-free parameter names associated
with the model.
- s2: S2.
- s2f: S2f.
- s2s: S2s.
- local_tm: local tm.
- te: te.
- tf: tf.
- ts: ts.
- rex: Rex.
- r: Bond length.
- csa: CSA value.
- nucleus: The heteronucleus type.
- chi2: Chi-squared value.
- iter: Iterations.
- f_count: Function count.
- g_count: Gradient count.
- h_count: Hessian count.
- warning: Minimisation warning.
+ - 'model', the model-free model name.
+ - 'equation', the model-free equation type.
+ - 'params', an array of the model-free parameter names
associated with the model.
+ - 's2', S2.
+ - 's2f', S2f.
+ - 's2s', S2s.
+ - 'local_tm', local tm.
+ - 'te', te.
+ - 'tf', tf.
+ - 'ts', ts.
+ - 'rex', Rex.
+ - 'r', bond length.
+ - 'csa', CSA value.
+ - 'nucleus', the heteronucleus type.
+ - 'chi2', chi-squared value.
+ - 'iter', iterations.
+ - 'f_count', function count.
+ - 'g_count', gradient count.
+ - 'h_count', hessian count.
+ - 'warning', minimisation warning.
@keyword set: The set of object names to return. This can
be set to 'all' for all
Modified: 1.3/specific_fns/relax_fit.py
URL:
http://svn.gna.org/viewcvs/relax/1.3/specific_fns/relax_fit.py?rev=7937&r1=7936&r2=7937&view=diff
==============================================================================
--- 1.3/specific_fns/relax_fit.py (original)
+++ 1.3/specific_fns/relax_fit.py Wed Oct 22 22:25:33 2008
@@ -278,16 +278,16 @@
The names are as follows:
- params: An array of the parameter names associated with the
model.
- rx: Either the R1 or R2 relaxation rate.
- i0: The initial intensity.
- iinf: The intensity at infinity.
- chi2: Chi-squared value.
- iter: Iterations.
- f_count: Function count.
- g_count: Gradient count.
- h_count: Hessian count.
- warning: Minimisation warning.
+ - 'params', an array of the parameter names associated with the
model.
+ - 'rx', either the R1 or R2 relaxation rate.
+ - 'i0', the initial intensity.
+ - 'iinf', the intensity at infinity.
+ - 'chi2', chi-squared value.
+ - 'iter', iterations.
+ - 'f_count', function count.
+ - 'g_count', gradient count.
+ - 'h_count', hessian count.
+ - 'warning', minimisation warning.
@keyword set: The set of object names to return. This can
be set to 'all' for all
Modified: 1.3/test_suite/test_suite_runner.py
URL:
http://svn.gna.org/viewcvs/relax/1.3/test_suite/test_suite_runner.py?rev=7937&r1=7936&r2=7937&view=diff
==============================================================================
--- 1.3/test_suite/test_suite_runner.py (original)
+++ 1.3/test_suite/test_suite_runner.py Wed Oct 22 22:25:33 2008
@@ -39,8 +39,8 @@
"""Class for running all components of the relax test suite.
This currently includes the following categories of tests:
- System/functional tests.
- Unit tests.
+ - System/functional tests.
+ - Unit tests.
"""
def __init__(self, relax):
r7937 - in /1.3: specific_fns/ specific_fns/model_free/ test_suite/