[commit: packages/deepseq] master: Refactor and extend documentation (0b22c98)

[git at git.haskell.org]

Repository : ssh://git@git.haskell.org/deepseq

On branch  : master
Link       : http://git.haskell.org/packages/deepseq.git/commitdiff/0b22c9825ef79c1ee41d2f19e7c997f5cdc93494

>---------------------------------------------------------------

commit 0b22c9825ef79c1ee41d2f19e7c997f5cdc93494
Author: Herbert Valerio Riedel <hvr at gnu.org>
Date:   Sat Apr 22 10:52:39 2017 +0200

    Refactor and extend documentation
    
    With the recent new API additions it makes sense to restructure
    a bit. Moreoever, this commit augments the new NFData1/NFData2 API
    with a few more haddock strings, and extends the introductory examples.


>---------------------------------------------------------------

0b22c9825ef79c1ee41d2f19e7c997f5cdc93494
 Control/DeepSeq.hs          | 58 ++++++++++++++++++++++++++++++++++++---------
 Control/DeepSeq/BackDoor.hs |  9 +++----
 2 files changed, 52 insertions(+), 15 deletions(-)

diff --git a/Control/DeepSeq.hs b/Control/DeepSeq.hs
index 32d8b7d..7296b97 100644
--- a/Control/DeepSeq.hs
+++ b/Control/DeepSeq.hs
@@ -26,21 +26,29 @@
 -- Stability   :  stable
 -- Portability :  portable
 --
--- This module provides an overloaded function, 'deepseq', for fully
--- evaluating data structures (that is, evaluating to \"Normal Form\").
+-- This module provides overloaded functions, such as 'deepseq' and
+-- 'rnf', for fully evaluating data structures (that is, evaluating to
+-- \"Normal Form\").
 --
 -- A typical use is to prevent resource leaks in lazy IO programs, by
 -- forcing all characters from a file to be read. For example:
 --
 -- > import System.IO
 -- > import Control.DeepSeq
+-- > import Control.Exception (evaluate)
 -- >
--- > main = do
--- >     h <- openFile "f" ReadMode
+-- > readFile' :: FilePath -> IO String
+-- > readFile' fn = do
+-- >     h <- openFile fn ReadMode
 -- >     s <- hGetContents h
--- >     s `deepseq` hClose h
+-- >     evaluate (rnf s)
+-- >     hClose h
 -- >     return s
 --
+-- __Note__: The example above should rather be written in terms of
+-- 'Control.Exception.bracket' to ensure releasing file-descriptors in
+-- a timely matter (see the description of 'force' for an example).
+--
 -- 'deepseq' differs from 'seq' as it traverses data structures deeply,
 -- for example, 'seq' will evaluate only to the first constructor in
 -- the list:
@@ -61,10 +69,20 @@
 --
 -- @since 1.1.0.0
 module Control.DeepSeq (
-     deepseq, ($!!), force, (<$!!>), rwhnf,
-     NFData(..),
-     NFData1(..), rnf1,
-     NFData2(..), rnf2
+     -- * 'NFData' class
+     NFData(rnf),
+     -- * Helper functions
+     deepseq,
+     force,
+     ($!!),
+     (<$!!>),
+     rwhnf,
+
+     -- * Liftings of the 'NFData' class
+     -- ** For unary constructors
+     NFData1(liftRnf), rnf1,
+     -- ** For binary constructors
+     NFData2(liftRnf2), rnf2,
   ) where
 
 import Control.Applicative
@@ -236,6 +254,12 @@ f $!! x = x `deepseq` f x
 -- >   {- 'result' will be fully evaluated at this point -}
 -- >   return ()
 --
+-- Finally, here's an exception safe variant of the @readFile'@ example:
+--
+-- > readFile' :: FilePath -> IO String
+-- > readFile' fn = bracket (openFile fn ReadMode) hClose $ \h ->
+-- >                        evaluate . force =<< hGetContents h
+--
 -- @since 1.2.0.0
 force :: (NFData a) => a -> a
 force x = x `deepseq` x
@@ -256,6 +280,8 @@ infixl 4 <$!!>
 
 -- | Reduce to weak head normal form
 --
+-- Equivalent to @\\x -> 'seq' x ()@.
+--
 -- Useful for defining 'NFData' for types for which NF=WHNF holds.
 --
 -- > data T = C1 | C2 | C3
@@ -356,7 +382,9 @@ class NFData1 f where
     default liftRnf :: (Generic1 f, GNFData One (Rep1 f)) => (a -> ()) -> f a -> ()
     liftRnf r = grnf (RnfArgs1 r) . from1
 
--- |@since 1.4.3.0
+-- | Lift the standard 'rnf' function through the type constructor.
+--
+-- @since 1.4.3.0
 rnf1 :: (NFData1 f, NFData a) => f a -> ()
 rnf1 = liftRnf rnf
 
@@ -364,9 +392,17 @@ rnf1 = liftRnf rnf
 --
 -- @since 1.4.3.0
 class NFData2 p where
+    -- | 'liftRnf2' should reduce its argument to normal form (that
+    -- is, fully evaluate all sub-components), given functions to
+    -- reduce @a@ and @b@ arguments respectively, and then return '()'.
+    --
+    -- __Note__: Unlike for the unary 'liftRnf', there is currently no
+    -- support for generically deriving 'liftRnf2'.
     liftRnf2 :: (a -> ()) -> (b -> ()) -> p a b -> ()
 
--- |@since 1.4.3.0
+-- | Lift the standard 'rnf' function through the type constructor.
+--
+-- @since 1.4.3.0
 rnf2 :: (NFData2 p, NFData a, NFData b) => p a b -> ()
 rnf2 = liftRnf2 rnf rnf
 
diff --git a/Control/DeepSeq/BackDoor.hs b/Control/DeepSeq/BackDoor.hs
index 356254b..343ec56 100644
--- a/Control/DeepSeq/BackDoor.hs
+++ b/Control/DeepSeq/BackDoor.hs
@@ -1,5 +1,10 @@
 {-# LANGUAGE CPP #-}
 
+-- | Hack to keep Control.DeepSeq SAFE-inferred
+--
+-- This module only re-export reasonably safe entities from non-safe
+-- modules when there is no safe alternative
+
 #if MIN_VERSION_base(4,9,0) || (MIN_VERSION_base(4,6,0) && !MIN_VERSION_base(4,7,0))
 {-# LANGUAGE Safe #-}
 
@@ -10,10 +15,6 @@ module Control.DeepSeq.BackDoor
 #else
 {-# LANGUAGE Trustworthy #-}
 
--- | Hack to keep Control.DeepSeq SAFE-inferred
---
--- This module only re-export reasonably safe entities from non-safe
--- modules when there is no safe alternative
 module Control.DeepSeq.BackDoor
     ( module X
     ) where