summaryrefslogtreecommitdiff
path: root/libraries/base/Data/Unique.hs
diff options
context:
space:
mode:
authorOleg Grenrus <oleg.grenrus@iki.fi>2020-12-26 00:28:12 +0200
committerMarge Bot <ben+marge-bot@smart-cactus.org>2021-01-02 07:36:33 -0500
commitaa17b84dab91408090f079f85d62ef3221f4ab88 (patch)
treed018205fc9de5d52039d3f2be1041d297efc4c29 /libraries/base/Data/Unique.hs
parent4c178374983dddb75341352aef1d15658a82463b (diff)
downloadhaskell-aa17b84dab91408090f079f85d62ef3221f4ab88.tar.gz
Correct doctests
It's simpler to assume that base is NoImplicitPrelude, otherwise running doctest on `GHC.*` modules would be tricky. OTOH, most `GHC.List` (where the most name clashes are) examples could be changed to use `import qualified Data.List as L`. (GHC.List examples won't show for Foldable methods...). With these changes majority of doctest examples are GHCi-"faithful", my WIP GHC-independent doctest runner reports nice summary: Examples: 582; Tried: 546; Skipped: 34; Success: 515; Errors: 33; Property Failures 2 Most error cases are *Hangs forever*. I have yet to figure out how to demonstrate that in GHCi. Some of divergences are actually stack overflows, i.e. caught by runtime. Few errorful cases are examples of infinite output, e.g. >>> cycle [42] [42,42,42,42,42,42,42,42,42,42... while correct, they confuse doctest. Another erroneous cases are where expected output has line comment, like >>> fmap show (Just 1) -- (a -> b) -> f a -> f b Just "1" -- (Int -> String) -> Maybe Int -> Maybe String I think I just have to teach doctest to strip comments from expected output. This is a first patch in a series. There is plenty of stuff already.
Diffstat (limited to 'libraries/base/Data/Unique.hs')
-rw-r--r--libraries/base/Data/Unique.hs3
1 files changed, 3 insertions, 0 deletions
diff --git a/libraries/base/Data/Unique.hs b/libraries/base/Data/Unique.hs
index 95b94102d1..c14b063b3b 100644
--- a/libraries/base/Data/Unique.hs
+++ b/libraries/base/Data/Unique.hs
@@ -26,6 +26,9 @@ import System.IO.Unsafe (unsafePerformIO)
import GHC.Num
import Data.IORef
+-- $setup
+-- >>> import Prelude
+
-- | An abstract unique object. Objects of type 'Unique' may be
-- compared for equality and ordering and hashed into 'Int'.
--