r5165 - /1.3/generic_fns/align_tensor.py -- March 22, 2008 - 23:25

Author: bugman
Date: Sat Mar 22 23:25:04 2008
New Revision: 5165

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


Modified:
    1.3/generic_fns/align_tensor.py

Modified: 1.3/generic_fns/align_tensor.py
URL: 
http://svn.gna.org/viewcvs/relax/1.3/generic_fns/align_tensor.py?rev=5165&r1=5164&r2=5165&view=diff
==============================================================================
--- 1.3/generic_fns/align_tensor.py (original)
+++ 1.3/generic_fns/align_tensor.py Sat Mar 22 23:25:04 2008
@@ -1328,7 +1328,7 @@
 def svd(basis_set=0, tensors=None):
     """Function for calculating the singular values of all the loaded 
tensors.
 
-    The matrix on which SVD will be performed is:
+    The matrix on which SVD will be performed is::
 
         | Sxx1 Syy1 Sxy1 Sxz1 Syz1 |
         | Sxx2 Syy2 Sxy2 Sxz2 Syz2 |
@@ -1340,7 +1340,7 @@
 
     This is the default unitary basis set (selected when basis_set is 0).  
Alternatively a geometric
     basis set consisting of the stretching and skewing parameters Szz and 
Sxx-yy respectively
-    replacing Sxx and Syy can be chosen by setting basis_set to 1.  The 
matrix in this case is:
+    replacing Sxx and Syy can be chosen by setting basis_set to 1.  The 
matrix in this case is::
 
         | Szz1 Sxxyy1 Sxy1 Sxz1 Syz1 |
         | Szz2 Sxxyy2 Sxy2 Sxz2 Syz2 |
@@ -1350,7 +1350,7 @@
         |  .     .     .    .    .   |
         | SzzN SxxyyN SxyN SxzN SyzN |
 
-    The relationships between the geometric and unitary basis sets are:
+    The relationships between the geometric and unitary basis sets are::
 
         Szz = - Sxx - Syy,
         Sxxyy = Sxx - Syy,