Specify IEEE-754 in the haddocks for the new Float/Double functions.
authorLennart Kolmodin <kolmodin@gmail.com>
Wed, 1 Jun 2016 20:15:14 +0000 (22:15 +0200)
committerLennart Kolmodin <kolmodin@gmail.com>
Wed, 1 Jun 2016 20:15:14 +0000 (22:15 +0200)
src/Data/Binary/Get.hs
src/Data/Binary/Put.hs

index a5282d6..dcabf72 100644 (file)
@@ -622,32 +622,32 @@ getInt64host = getPtr  (sizeOf (undefined :: Int64))
 ------------------------------------------------------------------------
 -- Double/Float reads
 
--- | Read a 'Float' in big endian format.
+-- | Read a 'Float' in big endian IEEE-754 format.
 getFloatbe :: Get Float
 getFloatbe = wordToFloat <$> getWord32be
 {-# INLINE getFloatbe #-}
 
--- | Read a 'Float' in little endian format.
+-- | Read a 'Float' in little endian IEEE-754 format.
 getFloatle :: Get Float
 getFloatle = wordToFloat <$> getWord32le
 {-# INLINE getFloatle #-}
 
--- | Read a 'Float' in native host order and host endianess.
+-- | Read a 'Float' in IEEE-754 format and host endian.
 getFloathost :: Get Float
 getFloathost = wordToFloat <$> getWord32host
 {-# INLINE getFloathost #-}
 
--- | Read a 'Double' in big endian format.
+-- | Read a 'Double' in big endian IEEE-754 format.
 getDoublebe :: Get Double
 getDoublebe = wordToDouble <$> getWord64be
 {-# INLINE getDoublebe #-}
 
--- | Read a 'Double' in little endian format.
+-- | Read a 'Double' in little endian IEEE-754 format.
 getDoublele :: Get Double
 getDoublele = wordToDouble <$> getWord64le
 {-# INLINE getDoublele #-}
 
--- | Read a 'Double' in native host order and host endianess.
+-- | Read a 'Double' in IEEE-754 format and host endian.
 getDoublehost :: Get Double
 getDoublehost = wordToDouble <$> getWord64host
 {-# INLINE getDoublehost #-}
index de18ab0..32fb618 100644 (file)
@@ -357,32 +357,32 @@ putInt64host       = tell . B.putInt64host
 ------------------------------------------------------------------------
 -- Floats/Doubles
 
--- | Write a 'Float' in big endian format.
+-- | Write a 'Float' in big endian IEEE-754 format.
 putFloatbe :: Float -> Put
 putFloatbe = putWord32be . floatToWord
 {-# INLINE putFloatbe #-}
 
--- | Write a 'Float' in little endian format.
+-- | Write a 'Float' in little endian IEEE-754 format.
 putFloatle :: Float -> Put
 putFloatle = putWord32le . floatToWord
 {-# INLINE putFloatle #-}
 
--- | Write a 'Float' in native host order and host endianness.
+-- | Write a 'Float' in native in IEEE-754 format and host endian.
 putFloathost :: Float -> Put
 putFloathost = putWord32host . floatToWord
 {-# INLINE putFloathost #-}
 
--- | Write a 'Double' in big endian format.
+-- | Write a 'Double' in big endian IEEE-754 format.
 putDoublebe :: Double -> Put
 putDoublebe = putWord64be . doubleToWord
 {-# INLINE putDoublebe #-}
 
--- | Write a 'Double' in little endian format.
+-- | Write a 'Double' in little endian IEEE-754 format.
 putDoublele :: Double -> Put
 putDoublele = putWord64le . doubleToWord
 {-# INLINE putDoublele #-}
 
--- | Write a 'Double' in native host order and host endianness.
+-- | Write a 'Double' in native in IEEE-754 format and host endian.
 putDoublehost :: Double -> Put
 putDoublehost = putWord64host . doubleToWord
 {-# INLINE putDoublehost #-}