Fix Haddock comment for Integer datatype
authorAlexandre Baldé <alexandrer_b@outlook.com>
Thu, 7 Feb 2019 12:31:44 +0000 (12:31 +0000)
committerMarge Bot <ben+marge-bot@smart-cactus.org>
Tue, 19 Feb 2019 00:17:33 +0000 (19:17 -0500)
Move implementation notes for Integer to Haddock named section

Revert documentation named chunk change [skip ci]

Haddock's named chunk feature was not used correctly in this case,
as it cannot export only parts of a Haddock top level comment.

As such, it was removed and replaced by a message informing the end-
user to browse the source code for detailed information.

libraries/integer-gmp/src/GHC/Integer/Type.hs

index 3434df2..8a1a574 100644 (file)
@@ -136,13 +136,17 @@ instance Eq BigNat where
 instance Ord BigNat where
     compare = compareBigNat
 
--- | Invariant: 'Jn#' and 'Jp#' are used iff value doesn't fit in 'S#'
+-- [Implementation notes]
+--
+-- Invariant: 'Jn#' and 'Jp#' are used iff value doesn't fit in 'S#'
 --
 -- Useful properties resulting from the invariants:
 --
 --  - @abs ('S#' _) <= abs ('Jp#' _)@
 --  - @abs ('S#' _) <  abs ('Jn#' _)@
---
+
+-- | Arbitrary precision integers. For more information about this datatype,
+-- see the comments in its implementation.
 data Integer  = S#                !Int#
                 -- ^ iff value in @[minBound::'Int', maxBound::'Int']@ range
               | Jp# {-# UNPACK #-} !BigNat