r5006 - /1.3/generic_fns/structure.py -- February 15, 2008 - 11:10

Author: bugman
Date: Fri Feb 15 11:10:27 2008
New Revision: 5006

URL: http://svn.gna.org/viewcvs/relax?rev=5006&view=rev
Log:
Converted the generic_fns.structure.centre_of_mass() docstring to epydoc 
format.


Modified:
    1.3/generic_fns/structure.py

Modified: 1.3/generic_fns/structure.py
URL: 
http://svn.gna.org/viewcvs/relax/1.3/generic_fns/structure.py?rev=5006&r1=5005&r2=5006&view=diff
==============================================================================
--- 1.3/generic_fns/structure.py (original)
+++ 1.3/generic_fns/structure.py Fri Feb 15 11:10:27 2008
@@ -186,7 +186,15 @@
 
 
 def centre_of_mass(return_mass=False):
-    """Calculate and return the centre of mass of the structure."""
+    """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)
+    """
 
     # Alias the current data pipe.
     cdp = relax_data_store[relax_data_store.current_pipe]