[Git][ghc/ghc][master] Update Lock.hs with more documentation to make sure that the Boolean return value is clear.

[Marge Bot]

 Marge Bot pushed to branch master at Glasgow Haskell Compiler / GHC


Commits:
04d64331 by syd at cs-syd.eu at 2020-09-24T13:15:54-04:00
Update Lock.hs with more documentation to make sure that the Boolean return value is clear.

[skip ci]

- - - - -


1 changed file:

- libraries/base/GHC/IO/Handle/Lock.hs


Changes:

=====================================
libraries/base/GHC/IO/Handle/Lock.hs
=====================================
@@ -52,6 +52,8 @@ hLock h mode = void $ lockImpl h "hLock" mode True
 
 -- | Non-blocking version of 'hLock'.
 --
+-- Returns 'True' if taking the lock was successful and 'False' otherwise.
+--
 -- @since 4.10.0.0
 hTryLock :: Handle -> LockMode -> IO Bool
 hTryLock h mode = lockImpl h "hTryLock" mode False



View it on GitLab: https://gitlab.haskell.org/ghc/ghc/-/commit/04d6433158d95658684cf419c4ba5725d2aa539e

-- 
View it on GitLab: https://gitlab.haskell.org/ghc/ghc/-/commit/04d6433158d95658684cf419c4ba5725d2aa539e
You're receiving this email because of your account on gitlab.haskell.org.


-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.haskell.org/pipermail/ghc-commits/attachments/20200924/59a944b3/attachment-0001.html>