r5036 - /1.3/generic_fns/structure.py -- February 20, 2008 - 09:32

Author: bugman
Date: Wed Feb 20 09:32:44 2008
New Revision: 5036

URL: http://svn.gna.org/viewcvs/relax?rev=5036&view=rev
Log:
Updated the docstring of the generic_fns.structure.atomic_mass() function 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=5036&r1=5035&r2=5036&view=diff
==============================================================================
--- 1.3/generic_fns/structure.py (original)
+++ 1.3/generic_fns/structure.py Wed Feb 20 09:32:44 2008
@@ -156,7 +156,13 @@
 
 
 def atomic_mass(element=None):
-    """Return the atomic mass of the given element."""
+    """Return the atomic mass of the given element.
+
+    @param element: The name of the element to return the atomic mass of.
+    @type element:  str
+    @return:        The relative atomic mass.
+    @rtype:         float
+    """
 
     # Proton.
     if element == 'H' or element == 'Q':