Author: bugman
Date: Wed Apr 9 17:05:57 2014
New Revision: 22668
URL: http://svn.gna.org/viewcvs/relax?rev=22668&view=rev
Log:
Fixes for the module/package docstring comments.
Modified:
trunk/specific_analyses/consistency_tests/api.py
trunk/specific_analyses/consistency_tests/uf.py
trunk/specific_analyses/jw_mapping/api.py
trunk/specific_analyses/jw_mapping/uf.py
trunk/specific_analyses/model_free/__init__.py
trunk/specific_analyses/n_state_model/api.py
trunk/specific_analyses/n_state_model/data.py
trunk/specific_analyses/n_state_model/optimisation.py
trunk/specific_analyses/n_state_model/parameters.py
trunk/specific_analyses/n_state_model/uf.py
trunk/specific_analyses/noe/api.py
trunk/specific_analyses/relax_fit/api.py
trunk/specific_analyses/relax_fit/optimisation.py
trunk/specific_analyses/relax_fit/parameters.py
trunk/specific_analyses/relax_fit/uf.py
Modified: trunk/specific_analyses/consistency_tests/api.py
URL:
http://svn.gna.org/viewcvs/relax/trunk/specific_analyses/consistency_tests/api.py?rev=22668&r1=22667&r2=22668&view=diff
==============================================================================
--- trunk/specific_analyses/consistency_tests/api.py (original)
+++ trunk/specific_analyses/consistency_tests/api.py Wed Apr 9 17:05:57
2014
@@ -20,7 +20,7 @@
#
#
###############################################################################
-# Package docstring.
+# Module docstring.
"""The consistency testing analysis API object."""
# Python module imports.
Modified: trunk/specific_analyses/consistency_tests/uf.py
URL:
http://svn.gna.org/viewcvs/relax/trunk/specific_analyses/consistency_tests/uf.py?rev=22668&r1=22667&r2=22668&view=diff
==============================================================================
--- trunk/specific_analyses/consistency_tests/uf.py (original)
+++ trunk/specific_analyses/consistency_tests/uf.py Wed Apr 9 17:05:57
2014
@@ -20,7 +20,7 @@
#
#
###############################################################################
-# Package docstring.
+# Module docstring.
"""The consistency testing analysis user functions."""
# relax module imports.
Modified: trunk/specific_analyses/jw_mapping/api.py
URL:
http://svn.gna.org/viewcvs/relax/trunk/specific_analyses/jw_mapping/api.py?rev=22668&r1=22667&r2=22668&view=diff
==============================================================================
--- trunk/specific_analyses/jw_mapping/api.py (original)
+++ trunk/specific_analyses/jw_mapping/api.py Wed Apr 9 17:05:57 2014
@@ -19,7 +19,7 @@
#
#
###############################################################################
-# Package docstring.
+# Module docstring.
"""The reduced spectral density mapping API object."""
# Python module imports.
Modified: trunk/specific_analyses/jw_mapping/uf.py
URL:
http://svn.gna.org/viewcvs/relax/trunk/specific_analyses/jw_mapping/uf.py?rev=22668&r1=22667&r2=22668&view=diff
==============================================================================
--- trunk/specific_analyses/jw_mapping/uf.py (original)
+++ trunk/specific_analyses/jw_mapping/uf.py Wed Apr 9 17:05:57 2014
@@ -19,7 +19,7 @@
#
#
###############################################################################
-# Package docstring.
+# Module docstring.
"""Module for all of the reduced spectral density mapping specific user
functions."""
# relax module imports.
Modified: trunk/specific_analyses/model_free/__init__.py
URL:
http://svn.gna.org/viewcvs/relax/trunk/specific_analyses/model_free/__init__.py?rev=22668&r1=22667&r2=22668&view=diff
==============================================================================
--- trunk/specific_analyses/model_free/__init__.py (original)
+++ trunk/specific_analyses/model_free/__init__.py Wed Apr 9 17:05:57
2014
@@ -19,7 +19,7 @@
#
#
###############################################################################
-# Module docstring.
+# Package docstring.
"""The Lipari-Szabo model-free analysis."""
Modified: trunk/specific_analyses/n_state_model/api.py
URL:
http://svn.gna.org/viewcvs/relax/trunk/specific_analyses/n_state_model/api.py?rev=22668&r1=22667&r2=22668&view=diff
==============================================================================
--- trunk/specific_analyses/n_state_model/api.py (original)
+++ trunk/specific_analyses/n_state_model/api.py Wed Apr 9 17:05:57
2014
@@ -19,7 +19,7 @@
#
#
###############################################################################
-# Package docstring.
+# Module docstring.
"""The N-state model or structural ensemble analysis."""
# Python module imports.
Modified: trunk/specific_analyses/n_state_model/data.py
URL:
http://svn.gna.org/viewcvs/relax/trunk/specific_analyses/n_state_model/data.py?rev=22668&r1=22667&r2=22668&view=diff
==============================================================================
--- trunk/specific_analyses/n_state_model/data.py (original)
+++ trunk/specific_analyses/n_state_model/data.py Wed Apr 9 17:05:57
2014
@@ -19,7 +19,7 @@
#
#
###############################################################################
-# Package docstring.
+# Module docstring.
"""The N-state model or structural ensemble analysis base data handling."""
# Python module imports.
Modified: trunk/specific_analyses/n_state_model/optimisation.py
URL:
http://svn.gna.org/viewcvs/relax/trunk/specific_analyses/n_state_model/optimisation.py?rev=22668&r1=22667&r2=22668&view=diff
==============================================================================
--- trunk/specific_analyses/n_state_model/optimisation.py (original)
+++ trunk/specific_analyses/n_state_model/optimisation.py Wed Apr 9
17:05:57 2014
@@ -19,7 +19,7 @@
#
#
###############################################################################
-# Package docstring.
+# Module docstring.
"""The N-state model or structural ensemble analysis optimisation
functions."""
# Python module imports.
Modified: trunk/specific_analyses/n_state_model/parameters.py
URL:
http://svn.gna.org/viewcvs/relax/trunk/specific_analyses/n_state_model/parameters.py?rev=22668&r1=22667&r2=22668&view=diff
==============================================================================
--- trunk/specific_analyses/n_state_model/parameters.py (original)
+++ trunk/specific_analyses/n_state_model/parameters.py Wed Apr 9 17:05:57
2014
@@ -19,7 +19,7 @@
#
#
###############################################################################
-# Package docstring.
+# Module docstring.
"""The N-state model or structural ensemble analysis parameter handling."""
# Python module imports.
Modified: trunk/specific_analyses/n_state_model/uf.py
URL:
http://svn.gna.org/viewcvs/relax/trunk/specific_analyses/n_state_model/uf.py?rev=22668&r1=22667&r2=22668&view=diff
==============================================================================
--- trunk/specific_analyses/n_state_model/uf.py (original)
+++ trunk/specific_analyses/n_state_model/uf.py Wed Apr 9 17:05:57 2014
@@ -19,7 +19,7 @@
#
#
###############################################################################
-# Package docstring.
+# Module docstring.
"""The N-state model or structural ensemble analysis user functions."""
# Python module imports.
Modified: trunk/specific_analyses/noe/api.py
URL:
http://svn.gna.org/viewcvs/relax/trunk/specific_analyses/noe/api.py?rev=22668&r1=22667&r2=22668&view=diff
==============================================================================
--- trunk/specific_analyses/noe/api.py (original)
+++ trunk/specific_analyses/noe/api.py Wed Apr 9 17:05:57 2014
@@ -19,7 +19,7 @@
#
#
###############################################################################
-# Package docstring.
+# Module docstring.
"""The steady-state heteronuclear NOE API object."""
# Python module imports.
Modified: trunk/specific_analyses/relax_fit/api.py
URL:
http://svn.gna.org/viewcvs/relax/trunk/specific_analyses/relax_fit/api.py?rev=22668&r1=22667&r2=22668&view=diff
==============================================================================
--- trunk/specific_analyses/relax_fit/api.py (original)
+++ trunk/specific_analyses/relax_fit/api.py Wed Apr 9 17:05:57 2014
@@ -19,7 +19,7 @@
#
#
###############################################################################
-# Package docstring.
+# Module docstring.
"""The R1 and R2 exponential relaxation curve fitting API object."""
# Python module imports.
Modified: trunk/specific_analyses/relax_fit/optimisation.py
URL:
http://svn.gna.org/viewcvs/relax/trunk/specific_analyses/relax_fit/optimisation.py?rev=22668&r1=22667&r2=22668&view=diff
==============================================================================
--- trunk/specific_analyses/relax_fit/optimisation.py (original)
+++ trunk/specific_analyses/relax_fit/optimisation.py Wed Apr 9 17:05:57
2014
@@ -19,7 +19,7 @@
#
#
###############################################################################
-# Package docstring.
+# Module docstring.
"""The R1 and R2 exponential relaxation curve fitting optimisation
functions."""
# Python module imports.
Modified: trunk/specific_analyses/relax_fit/parameters.py
URL:
http://svn.gna.org/viewcvs/relax/trunk/specific_analyses/relax_fit/parameters.py?rev=22668&r1=22667&r2=22668&view=diff
==============================================================================
--- trunk/specific_analyses/relax_fit/parameters.py (original)
+++ trunk/specific_analyses/relax_fit/parameters.py Wed Apr 9 17:05:57
2014
@@ -19,7 +19,7 @@
#
#
###############################################################################
-# Package docstring.
+# Module docstring.
"""The R1 and R2 exponential relaxation curve fitting parameter functions."""
# Python module imports.
Modified: trunk/specific_analyses/relax_fit/uf.py
URL:
http://svn.gna.org/viewcvs/relax/trunk/specific_analyses/relax_fit/uf.py?rev=22668&r1=22667&r2=22668&view=diff
==============================================================================
--- trunk/specific_analyses/relax_fit/uf.py (original)
+++ trunk/specific_analyses/relax_fit/uf.py Wed Apr 9 17:05:57 2014
@@ -19,7 +19,7 @@
#
#
###############################################################################
-# Package docstring.
+# Module docstring.
"""The R1 and R2 exponential relaxation curve fitting user functions."""
# relax module imports.
r22668 - in /trunk/specific_analyses: consistency_tests/ jw_mapping/ model_free/ n_state_model/ noe/ relax_fit/