More explicit comment on switch in registerDelay
authorKirill Zaborsky <qrilka@gmail.com>
Thu, 10 May 2018 14:57:59 +0000 (17:57 +0300)
committerBen Gamari <ben@smart-cactus.org>
Tue, 15 May 2018 14:45:40 +0000 (10:45 -0400)
libraries/base/GHC/Conc/IO.hs

index eb0bffe..3c37cbd 100644 (file)
@@ -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