r9318 - in /1.3: generic_fns/ generic_fns/structure/ specific_fns/ -- August 14, 2009 - 17:28

Author: bugman
Date: Fri Aug 14 17:28:03 2009
New Revision: 9318

URL: http://svn.gna.org/viewcvs/relax?rev=9318&view=rev
Log:
Epydoc docstring fixes.


Modified:
    1.3/generic_fns/frame_order.py
    1.3/generic_fns/sequence.py
    1.3/generic_fns/structure/api_base.py
    1.3/specific_fns/n_state_model.py

Modified: 1.3/generic_fns/frame_order.py
URL: 
http://svn.gna.org/viewcvs/relax/1.3/generic_fns/frame_order.py?rev=9318&r1=9317&r2=9318&view=diff
==============================================================================
--- 1.3/generic_fns/frame_order.py (original)
+++ 1.3/generic_fns/frame_order.py Fri Aug 14 17:28:03 2009
@@ -31,7 +31,7 @@
     """Nicely print out the Frame Order matrix of the 2nd degree.
 
     @param matrix:  The 3D, rank-4 Frame Order matrix.
-    @type name:     numpy 3D, rank-4 array
+    @type matrix:   numpy 3D, rank-4 array
     @keyword name:  The name of the matrix.
     @type name:     None or str
     """

Modified: 1.3/generic_fns/sequence.py
URL: 
http://svn.gna.org/viewcvs/relax/1.3/generic_fns/sequence.py?rev=9318&r1=9317&r2=9318&view=diff
==============================================================================
--- 1.3/generic_fns/sequence.py (original)
+++ 1.3/generic_fns/sequence.py Fri Aug 14 17:28:03 2009
@@ -91,7 +91,7 @@
     @type fail:         bool
     @return:            1 if the sequence is the same, 0 if different.
     @rtype:             int
-    @raises:            RelaxError if the sequence is different and the fail 
flag is True.
+    @raises RelaxError: If the sequence is different and the fail flag is 
True.
     """
 
     # Failure status.

Modified: 1.3/generic_fns/structure/api_base.py
URL: 
http://svn.gna.org/viewcvs/relax/1.3/generic_fns/structure/api_base.py?rev=9318&r1=9317&r2=9318&view=diff
==============================================================================
--- 1.3/generic_fns/structure/api_base.py (original)
+++ 1.3/generic_fns/structure/api_base.py Fri Aug 14 17:28:03 2009
@@ -204,7 +204,7 @@
         @param model:   The model number.
         @type model:    int or None
         @return:        The ModelContainer corresponding to the model number 
or that newly created.
-        @rteyp:         ModelContainer instance
+        @rtype:         ModelContainer instance
         """
 
         # Check if the target is a single model.

Modified: 1.3/specific_fns/n_state_model.py
URL: 
http://svn.gna.org/viewcvs/relax/1.3/specific_fns/n_state_model.py?rev=9318&r1=9317&r2=9318&view=diff
==============================================================================
--- 1.3/specific_fns/n_state_model.py (original)
+++ 1.3/specific_fns/n_state_model.py Fri Aug 14 17:28:03 2009
@@ -963,7 +963,7 @@
     def calc_ave_dist(self, atom1, atom2, exp=1):
         """Calculate the average distances.
 
-        The formula used is:
+        The formula used is::
 
                       _N_
                   / 1 \                  \ 1/exp