From: Simon Marlow <simonmar@microsoft.com>
Date: Tue, 8 May 2007 08:17:12 +0000 (+0000)
Subject: improve documentation for evaluate
X-Git-Tag: 2007-09-13~98
X-Git-Url: http://git.megacz.com/?a=commitdiff_plain;ds=sidebyside;h=d869f2fcfac24f46966e444feebad4e227d05c27;p=ghc-base.git

improve documentation for evaluate
---

diff --git a/GHC/Exception.lhs b/GHC/Exception.lhs
index 073e7a9..fd28004 100644
--- a/GHC/Exception.lhs
+++ b/GHC/Exception.lhs
@@ -111,7 +111,10 @@ unblock (IO io) = IO $ unblockAsyncExceptions# io
 -- >   evaluate x >>= f      ==>  (return $! x) >>= f
 --
 -- /Note:/ the first equation implies that @(evaluate x)@ is /not/ the
--- same as @(return $! x)@.
+-- same as @(return $! x)@.  A correct definition is
+--
+-- >   evaluate x = (return $! x) >>= return
+--
 evaluate :: a -> IO a
 evaluate a = IO $ \s -> case a `seq` () of () -> (# s, a #)
         -- NB. can't write