Remove Control.Parallel*, now in package parallel
[haskell-directory.git] / GHC / ST.lhs
index 413a045..909a8da 100644 (file)
@@ -39,13 +39,18 @@ too many people got bitten by space leaks when it was lazy.
 -- by @s@, and returns a value of type @a@.
 -- The @s@ parameter is either
 --
--- * an unstantiated type variable (inside invocations of 'runST'), or
+-- * an uninstantiated type variable (inside invocations of 'runST'), or
 --
 -- * 'RealWorld' (inside invocations of 'Control.Monad.ST.stToIO').
 --
 -- It serves to keep the internal states of different invocations
 -- of 'runST' separate from each other and from invocations of
 -- 'Control.Monad.ST.stToIO'.
+--
+-- The '>>=' and '>>' operations are strict in the state (though not in
+-- values stored in the state).  For example,
+--
+-- @'runST' (writeSTRef _|_ v >>= f) = _|_@
 newtype ST s a = ST (STRep s a)
 type STRep s a = State# s -> (# State# s, a #)