integer-simple: Add documentation for Integer type
authorBen Gamari <ben@smart-cactus.org>
Tue, 2 Apr 2019 21:00:22 +0000 (17:00 -0400)
committerMarge Bot <ben+marge-bot@smart-cactus.org>
Wed, 3 Apr 2019 04:41:05 +0000 (00:41 -0400)
libraries/integer-simple/GHC/Integer/Type.hs

index cdbeb86..ceb4c38 100644 (file)
@@ -34,6 +34,9 @@ import GHC.Tuple ()
 import GHC.IntWord64
 #endif
 
+-- | Arbitrary precision integers. In contrast with fixed-size integral types
+-- such as 'Int', the 'Integer' type represents the entire infinite range of
+-- integers.
 data Integer = Positive !Positive | Negative !Positive | Naught
 
 -------------------------------------------------------------------