r5167 - /1.3/generic_fns/diffusion_tensor.py -- March 22, 2008 - 23:29

Author: bugman
Date: Sat Mar 22 23:29:03 2008
New Revision: 5167

URL: http://svn.gna.org/viewcvs/relax?rev=5167&view=rev
Log:
Better epydoc support for the equations of the fold_angles() function.


Modified:
    1.3/generic_fns/diffusion_tensor.py

Modified: 1.3/generic_fns/diffusion_tensor.py
URL: 
http://svn.gna.org/viewcvs/relax/1.3/generic_fns/diffusion_tensor.py?rev=5167&r1=5166&r2=5167&view=diff
==============================================================================
--- 1.3/generic_fns/diffusion_tensor.py (original)
+++ 1.3/generic_fns/diffusion_tensor.py Sat Mar 22 23:29:03 2008
@@ -353,24 +353,24 @@
 def fold_angles(sim_index=None):
     """Wrap the Euler or spherical angles and remove the glide reflection 
and translational symmetries.
 
-    Wrap the angles such that
+    Wrap the angles such that::
 
         0 <= theta <= pi,
         0 <= phi <= 2pi,
 
-    and
+    and::
 
         0 <= alpha <= 2pi,
         0 <= beta <= pi,
         0 <= gamma <= 2pi.
 
 
-    For the simulated values, the angles are wrapped as
+    For the simulated values, the angles are wrapped as::
 
         theta - pi/2 <= theta_sim <= theta + pi/2
         phi - pi <= phi_sim <= phi + pi
 
-    and
+    and::
 
         alpha - pi <= alpha_sim <= alpha + pi
         beta - pi/2 <= beta_sim <= beta + pi/2