Doctests for Data.Tuple
authorDavid Luposchainsky <dluposchainsky@gmail.com>
Fri, 11 Aug 2017 08:37:55 +0000 (10:37 +0200)
committerBen Gamari <ben@smart-cactus.org>
Sat, 19 Aug 2017 03:28:16 +0000 (23:28 -0400)
libraries/base/Data/Tuple.hs

index 372e2b8..569dd14 100644 (file)
@@ -6,7 +6,7 @@
 -- Module      :  Data.Tuple
 -- Copyright   :  (c) The University of Glasgow 2001
 -- License     :  BSD-style (see the file libraries/base/LICENSE)
--- 
+--
 -- Maintainer  :  libraries@haskell.org
 -- Stability   :  experimental
 -- Portability :  portable
@@ -39,13 +39,32 @@ snd                     :: (a,b) -> b
 snd (_,y)               =  y
 
 -- | 'curry' converts an uncurried function to a curried function.
+--
+-- ==== __Examples__
+--
+-- >>> curry fst 1 2
+-- 1
 curry                   :: ((a, b) -> c) -> a -> b -> c
 curry f x y             =  f (x, y)
 
 -- | 'uncurry' converts a curried function to a function on pairs.
+--
+-- ==== __Examples__
+--
+-- >>> uncurry (+) (1,2)
+-- 3
+--
+-- >>> uncurry ($) (show, 1)
+-- "1"
+--
+-- >>> map (uncurry max) [(1,2), (3,4), (6,8)]
+-- [2,4,8]
 uncurry                 :: (a -> b -> c) -> ((a, b) -> c)
 uncurry f p             =  f (fst p) (snd p)
 
 -- | Swap the components of a pair.
 swap                    :: (a,b) -> (b,a)
 swap (a,b)              = (b,a)
+
+-- $setup
+-- >>> import Prelude hiding (curry, uncurry, fst, snd)