[Git][ghc/ghc][master] Better documentation for floatRange function

[Marge Bot (@marge-bot)]

Marge Bot pushed to branch master at Glasgow Haskell Compiler / GHC


Commits:
ea4b4391 by ARATA Mizuki at 2024-10-07T19:24:59-04:00
Better documentation for floatRange function

Closes #16479

- - - - -


1 changed file:

- libraries/ghc-internal/src/GHC/Internal/Float.hs


Changes:

=====================================
libraries/ghc-internal/src/GHC/Internal/Float.hs
=====================================
@@ -282,8 +282,10 @@ class  (RealFrac a, Floating a) => RealFloat a  where
     -- | a constant function, returning the number of digits of
     -- 'floatRadix' in the significand
     floatDigits         :: a -> Int
-    -- | a constant function, returning the lowest and highest values
-    -- the exponent may assume
+    -- | A constant function, returning the lowest and highest values
+    -- that @'exponent' x@ may assume for a normal @x at .
+    -- The relation to IEEE @emin@ and @emax@ is
+    -- @'floatRange' x = (emin + 1, emax + 1)@.
     floatRange          :: a -> (Int,Int)
     -- | The function 'decodeFloat' applied to a real floating-point
     -- number returns the significand expressed as an 'Integer' and an



View it on GitLab: https://gitlab.haskell.org/ghc/ghc/-/commit/ea4b439116e30791964973797c709deedf0ea1e3

-- 
View it on GitLab: https://gitlab.haskell.org/ghc/ghc/-/commit/ea4b439116e30791964973797c709deedf0ea1e3
You're receiving this email because of your account on gitlab.haskell.org.


-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.haskell.org/pipermail/ghc-commits/attachments/20241007/b78c62e2/attachment.html>