r6928 - /branches/rdc_analysis/maths_fns/rdc.py -- July 09, 2008 - 19:54

Author: bugman
Date: Wed Jul  9 19:54:24 2008
New Revision: 6928

URL: http://svn.gna.org/viewcvs/relax?rev=6928&view=rev
Log:
Docstring fixes.


Modified:
    branches/rdc_analysis/maths_fns/rdc.py

Modified: branches/rdc_analysis/maths_fns/rdc.py
URL: 
http://svn.gna.org/viewcvs/relax/branches/rdc_analysis/maths_fns/rdc.py?rev=6928&r1=6927&r2=6928&view=diff
==============================================================================
--- branches/rdc_analysis/maths_fns/rdc.py (original)
+++ branches/rdc_analysis/maths_fns/rdc.py Wed Jul  9 19:54:24 2008
@@ -55,12 +55,14 @@
     @type vect:         numpy matrix
     @param K:           The total number of structures.
     @type K:            int
-    @param vector_5D:   The 5D vector object.  The vector format is {Axx, 
Ayy, Axy, Axz, Ayz}.
-    @type vector_5D:    numpy 5D vector
+    @param A:           The 5D vector object.  The vector format is {Axx, 
Ayy, Axy, Axz, Ayz}.
+    @type A:            numpy 5D vector
     @param weights:     The weights for each member of the ensemble.  The 
last weight is assumed to
                         be missing, and is calculated by this function.  
Hence the length should be
                         one less than K.
     @type weights:      numpy rank-1 array
+    @return:            The average RDC value.
+    @rtype:             float
     """
 
     # Initial back-calculated RDC value.
@@ -120,6 +122,8 @@
                         be missing, and is calculated by this function.  
Hence the length should be
                         one less than K.
     @type weights:      numpy rank-1 array
+    @return:            The average RDC value.
+    @rtype:             float
     """
 
     # Initial back-calculated RDC value.