r5154 - /1.3/float.py -- March 22, 2008 - 22:14

Author: bugman
Date: Sat Mar 22 22:14:07 2008
New Revision: 5154

URL: http://svn.gna.org/viewcvs/relax?rev=5154&view=rev
Log:
Fixed the epytext '@raise' syntax in two docstrings.


Modified:
    1.3/float.py

Modified: 1.3/float.py
URL: 
http://svn.gna.org/viewcvs/relax/1.3/float.py?rev=5154&r1=5153&r2=5154&view=diff
==============================================================================
--- 1.3/float.py (original)
+++ 1.3/float.py Sat Mar 22 22:14:07 2008
@@ -391,8 +391,8 @@
     @type fromNumber:   float
     @param toDouble:    The python float to copy the sign bit to.
     @type toDouble:     float
-    @raises:            Throws a TypeError if toDouble isn't a python float 
or if fromNumber can't
-                        be converted to a float.
+    @raise TypeError:   If toDouble isn't a python float or if fromNumber 
can't be converted to a
+                        float.
     '''
 
     #convert first number to a float so as to use facilities
@@ -668,14 +668,14 @@
 def bitpatternToFloat(string, endian='big'):
     """Convert a 64 bit IEEE-754 ascii bit pattern into a 64 bit Python 
float.
 
-    @param string:  The ascii bit pattern repesenting the IEEE-754 float.
-    @type string:   str
-    @param endian:  The endianness of the bit pattern (can be 'big' or 
'little').
-    @type endian:   str
-    @return:        The 64 bit float corresponding to the IEEE-754 bit 
pattern.
-    @returntype:    float
-    @raise:         TypeError if 'string' is not a string, the length of the 
'string' is not 64, or
-        if 'string' does not consist solely of the characters '0' and '1'.
+    @param string:      The ascii bit pattern repesenting the IEEE-754 float.
+    @type string:       str
+    @param endian:      The endianness of the bit pattern (can be 'big' or 
'little').
+    @type endian:       str
+    @return:            The 64 bit float corresponding to the IEEE-754 bit 
pattern.
+    @returntype:        float
+    @raise TypeError:   If 'string' is not a string, the length of the 
'string' is not 64, or if
+                        'string' does not consist solely of the characters 
'0' and '1'.
     """
 
     # Test that the bit pattern is a string.