diff options
| author | syd@cs-syd.eu <syd@cs-syd.eu> | 2020-09-02 23:42:29 -0400 |
|---|---|---|
| committer | Marge Bot <ben+marge-bot@smart-cactus.org> | 2020-09-24 13:15:54 -0400 |
| commit | 04d6433158d95658684cf419c4ba5725d2aa539e (patch) | |
| tree | c9364122a5edd19ca6b3353a967a94e6a0192736 | |
| parent | 31fea307499009977fdf3dadedc98cfef986077a (diff) | |
| download | haskell-04d6433158d95658684cf419c4ba5725d2aa539e.tar.gz | |
Update Lock.hs with more documentation to make sure that the Boolean return value is clear.
[skip ci]
| -rw-r--r-- | libraries/base/GHC/IO/Handle/Lock.hs | 2 |
1 files changed, 2 insertions, 0 deletions
diff --git a/libraries/base/GHC/IO/Handle/Lock.hs b/libraries/base/GHC/IO/Handle/Lock.hs index 18319e1d29..919d680ff7 100644 --- a/libraries/base/GHC/IO/Handle/Lock.hs +++ b/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 |