[commit: ghc] master: More explicit comment on switch in registerDelay (1154c9b)

[git at git.haskell.org]

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

On branch  : master
Link       : http://ghc.haskell.org/trac/ghc/changeset/1154c9b6332342e0447ab64c082b016862bc97da/ghc

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

commit 1154c9b6332342e0447ab64c082b016862bc97da
Author: Kirill Zaborsky <qrilka at gmail.com>
Date:   Thu May 10 17:57:59 2018 +0300

    More explicit comment on switch in registerDelay


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

1154c9b6332342e0447ab64c082b016862bc97da
 libraries/base/GHC/Conc/IO.hs | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/libraries/base/GHC/Conc/IO.hs b/libraries/base/GHC/Conc/IO.hs
index eb0bffe..3c37cbd 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