r5155 - /1.3/float.py -- March 22, 2008 - 22:15

Author: bugman
Date: Sat Mar 22 22:15:49 2008
New Revision: 5155

URL: http://svn.gna.org/viewcvs/relax?rev=5155&view=rev
Log:
Updated the isNegInf() docstring.


Modified:
    1.3/float.py

Modified: 1.3/float.py
URL: 
http://svn.gna.org/viewcvs/relax/1.3/float.py?rev=5155&r1=5154&r2=5155&view=diff
==============================================================================
--- 1.3/float.py (original)
+++ 1.3/float.py Sat Mar 22 22:15:49 2008
@@ -652,14 +652,13 @@
 
 
 def isNegInf(obj):
-    ''' check to see if a python float is negative infinity
-
-
-        obj -- float object to check for negative infinity
-
-        returns -- True if object is a negative infinity
-
-        throws -- throws a TypeError if obj isn't a python float
+    '''Check to see if a python float is negative infinity.
+
+    @param obj:         Float object to check for negative infinity.
+    @type obj:          float
+    @returns:           True if object is a negative infinity.
+    @rtype:             bool
+    @raise TypeError:   If obj isn't a python float.
     '''
 
     return isInf(obj) and not isPositive(obj)