r11291 - /1.3/maths_fns/paramag_centre.py -- July 08, 2010 - 11:45

Author: bugman
Date: Thu Jul  8 11:45:21 2010
New Revision: 11291

URL: http://svn.gna.org/viewcvs/relax?rev=11291&view=rev
Log:
Docstring improvements - the geometric info should be in Angstroms.


Modified:
    1.3/maths_fns/paramag_centre.py

Modified: 1.3/maths_fns/paramag_centre.py
URL: 
http://svn.gna.org/viewcvs/relax/1.3/maths_fns/paramag_centre.py?rev=11291&r1=11290&r2=11291&view=diff
==============================================================================
--- 1.3/maths_fns/paramag_centre.py (original)
+++ 1.3/maths_fns/paramag_centre.py Thu Jul  8 11:45:21 2010
@@ -30,9 +30,9 @@
 def paramag_data(atomic_pos, paramag_centre, unit_vector, r):
     """Calculate the electron spin to nuclear spin unit vectors and 
distances.
 
-    @param atomic_pos:      The atomic positions.  The first index is the 
spins, the second is the structures, and the third is the atomic coordinates.
+    @param atomic_pos:      The atomic positions in Angstrom.  The first 
index is the spins, the second is the structures, and the third is the atomic 
coordinates.
     @type atomic_pos:       numpy rank-3 array
-    @param paramag_centre:  The paramagnetic centre position.
+    @param paramag_centre:  The paramagnetic centre position in Angstrom.
     @type paramag_centre:   numpy rank-1, 3D array
     @param unit_vector:     The structure to fill with the electron spin to 
nuclear spin unit vectors.
     @type unit_vector:      numpy rank-3 array