r5349 - /1.3/generic_fns/structure/mass.py -- April 07, 2008 - 13:59

Author: bugman
Date: Mon Apr  7 13:59:17 2008
New Revision: 5349

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


Modified:
    1.3/generic_fns/structure/mass.py

Modified: 1.3/generic_fns/structure/mass.py
URL: 
http://svn.gna.org/viewcvs/relax/1.3/generic_fns/structure/mass.py?rev=5349&r1=5348&r2=5349&view=diff
==============================================================================
--- 1.3/generic_fns/structure/mass.py (original)
+++ 1.3/generic_fns/structure/mass.py Mon Apr  7 13:59:17 2008
@@ -33,12 +33,12 @@
 def centre_of_mass(return_mass=False):
     """Calculate and return the centre of mass of the structure.
 
-    @param return_mass: A flag which if False will cause only the centre of 
mass to be returned, but
-                        if True will cause the centre of mass and the mass 
itself to be returned as
-                        a tuple.
-    @type return_mass:  bool
-    @return:            The centre of mass vector, and additionally the mass.
-    @rtype:             list of 3 floats (or tuple of a list of 3 floats and 
one float)
+    @keyword return_mass:   A flag which if False will cause only the centre 
of mass to be returned,
+                            but if True will cause the centre of mass and 
the mass itself to be
+                            returned as a tuple.
+    @type return_mass:      bool
+    @return:                The centre of mass vector, and additionally the 
mass.
+    @rtype:                 list of 3 floats (or tuple of a list of 3 floats 
and one float)
     """
 
     # Alias the current data pipe.