integer-gmp: Write friendlier documentation for Integer
authorBen Gamari <ben@smart-cactus.org>
Tue, 2 Apr 2019 20:59:29 +0000 (16:59 -0400)
committerMarge Bot <ben+marge-bot@smart-cactus.org>
Wed, 3 Apr 2019 04:41:05 +0000 (00:41 -0400)
libraries/integer-gmp/src/GHC/Integer/Type.hs

index 8a1a574..521cd95 100644 (file)
@@ -145,8 +145,12 @@ instance Ord BigNat where
 --  - @abs ('S#' _) <= abs ('Jp#' _)@
 --  - @abs ('S#' _) <  abs ('Jn#' _)@
 
--- | Arbitrary precision integers. For more information about this datatype,
--- see the comments in its implementation.
+-- | Arbitrary precision integers. In contrast with fixed-size integral types
+-- such as 'Int', the 'Integer' type represents the entire infinite range of
+-- integers.
+--
+-- For more information about this type's representation, see the comments in
+-- its implementation.
 data Integer  = S#                !Int#
                 -- ^ iff value in @[minBound::'Int', maxBound::'Int']@ range
               | Jp# {-# UNPACK #-} !BigNat