summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKirill Zaborsky <qrilka@gmail.com>2018-05-10 17:57:59 +0300
committerBen Gamari <ben@smart-cactus.org>2018-05-15 10:45:40 -0400
commit1154c9b6332342e0447ab64c082b016862bc97da (patch)
treed8763d7d275e01aebb316fa3c09042c534406094
parent45ad0c3946623bc8635d6e3964d9ebb1555a3df6 (diff)
downloadhaskell-1154c9b6332342e0447ab64c082b016862bc97da.tar.gz
More explicit comment on switch in registerDelay
-rw-r--r--libraries/base/GHC/Conc/IO.hs5
1 files changed, 3 insertions, 2 deletions
diff --git a/libraries/base/GHC/Conc/IO.hs b/libraries/base/GHC/Conc/IO.hs
index eb0bffe8b4..3c37cbda7c 100644
--- a/libraries/base/GHC/Conc/IO.hs
+++ b/libraries/base/GHC/Conc/IO.hs
@@ -188,8 +188,9 @@ threadDelay time
case delay# time# s of { s' -> (# s', () #)
}}
--- | Set the value of returned TVar to True after a given number of
--- microseconds. The caveats associated with threadDelay also apply.
+-- | Switch the value of returned 'TVar' from intial value 'False' to 'True'
+-- after a given number of microseconds. The caveats associated with
+-- 'threadDelay' also apply.
--
registerDelay :: Int -> IO (TVar Bool)
registerDelay usecs