r11966 - in /1.3: generic_fns/structure/cones.py maths_fns/coord_transform.py specific_fns/n_state_model.py -- December 27, 2010 - 13:17

Author: bugman
Date: Mon Dec 27 13:17:01 2010
New Revision: 11966

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


Modified:
    1.3/generic_fns/structure/cones.py
    1.3/maths_fns/coord_transform.py
    1.3/specific_fns/n_state_model.py

Modified: 1.3/generic_fns/structure/cones.py
URL: 
http://svn.gna.org/viewcvs/relax/1.3/generic_fns/structure/cones.py?rev=11966&r1=11965&r2=11966&view=diff
==============================================================================
--- 1.3/generic_fns/structure/cones.py (original)
+++ 1.3/generic_fns/structure/cones.py Mon Dec 27 13:17:01 2010
@@ -50,7 +50,7 @@
         @param phi:     The polar angle.
         @type phi:      float
         @param theta:   The azimuthal angle.
-        @type phi:      float
+        @type theta:    float
         @return:        True if the point is within the cone, False 
otherwise.
         @rtype:         bool
         """

Modified: 1.3/maths_fns/coord_transform.py
URL: 
http://svn.gna.org/viewcvs/relax/1.3/maths_fns/coord_transform.py?rev=11966&r1=11965&r2=11966&view=diff
==============================================================================
--- 1.3/maths_fns/coord_transform.py (original)
+++ 1.3/maths_fns/coord_transform.py Mon Dec 27 13:17:01 2010
@@ -63,10 +63,10 @@
     The parameter r is the radial distance, theta is the polar angle, and 
phi is the azimuth.
 
 
-    @param vector:  The spherical coordinate vector [r, theta, phi].
-    @type vector:   3D array or list
-    @return:        The Cartesian vector [x, y, z].
-    @rtype:         numpy rank-1, 3D array
+    @param spherical_vect:  The spherical coordinate vector [r, theta, phi].
+    @type spherical_vect:   3D array or list
+    @param cart_vect:       The Cartesian vector [x, y, z].
+    @type cart_vect:        3D array or list
     """
 
     # Trig alias.

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=11966&r1=11965&r2=11966&view=diff
==============================================================================
--- 1.3/specific_fns/n_state_model.py (original)
+++ 1.3/specific_fns/n_state_model.py Mon Dec 27 13:17:01 2010
@@ -2497,7 +2497,7 @@
         """Return the array of simulation parameter values.
 
         @param model_info:  The global model index originating from 
model_loop().
-        @type data_id:      int
+        @type model_info:   int
         @param index:       The index of the parameter to return the array 
of values for.
         @type index:        int
         @return:            The array of simulation parameter values.