diff options
| author | Alec Theriault <alec.theriault@gmail.com> | 2018-08-21 16:05:16 -0400 |
|---|---|---|
| committer | Ben Gamari <ben@smart-cactus.org> | 2018-08-21 18:56:11 -0400 |
| commit | ddffa0cd8da568c97011007fc6470c61cd4447e5 (patch) | |
| tree | 99729e70cf2d04acd2377158b47dfe378fcc8e2a /libraries/base/GHC/Event/Thread.hs | |
| parent | 14817621aae2d45f8272a36b171b9ccce8763bba (diff) | |
| download | haskell-ddffa0cd8da568c97011007fc6470c61cd4447e5.tar.gz | |
Fix ambiguous/out-of-scope Haddock identifiers
This drastically cuts down on the number of Haddock warnings when making
docs for `base`. Plus this means more actual links end up in the docs!
Also fixed other small mostly markup issues in the documentation along
the way.
This is a docs-only change.
Reviewers: hvr, bgamari, thomie
Reviewed By: thomie
Subscribers: thomie, rwbarton, carter
Differential Revision: https://phabricator.haskell.org/D5055
Diffstat (limited to 'libraries/base/GHC/Event/Thread.hs')
| -rw-r--r-- | libraries/base/GHC/Event/Thread.hs | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/libraries/base/GHC/Event/Thread.hs b/libraries/base/GHC/Event/Thread.hs index d4b679206a..a9d5410d9c 100644 --- a/libraries/base/GHC/Event/Thread.hs +++ b/libraries/base/GHC/Event/Thread.hs @@ -72,7 +72,7 @@ registerDelay usecs = do -- | Block the current thread until data is available to read from the -- given file descriptor. -- --- This will throw an 'IOError' if the file descriptor was closed +-- This will throw an 'Prelude.IOError' if the file descriptor was closed -- while this thread was blocked. To safely close a file descriptor -- that has been used with 'threadWaitRead', use 'closeFdWith'. threadWaitRead :: Fd -> IO () @@ -82,7 +82,7 @@ threadWaitRead = threadWait evtRead -- | Block the current thread until the given file descriptor can -- accept data to write. -- --- This will throw an 'IOError' if the file descriptor was closed +-- This will throw an 'Prelude.IOError' if the file descriptor was closed -- while this thread was blocked. To safely close a file descriptor -- that has been used with 'threadWaitWrite', use 'closeFdWith'. threadWaitWrite :: Fd -> IO () @@ -145,7 +145,7 @@ threadWaitSTM evt fd = mask_ $ do -- The second element of the return value pair is an IO action that can be used -- to deregister interest in the file descriptor. -- --- The STM action will throw an 'IOError' if the file descriptor was closed +-- The STM action will throw an 'Prelude.IOError' if the file descriptor was closed -- while the STM action is being executed. To safely close a file descriptor -- that has been used with 'threadWaitReadSTM', use 'closeFdWith'. threadWaitReadSTM :: Fd -> IO (STM (), IO ()) @@ -157,7 +157,7 @@ threadWaitReadSTM = threadWaitSTM evtRead -- The second element of the return value pair is an IO action that can be used to deregister -- interest in the file descriptor. -- --- The STM action will throw an 'IOError' if the file descriptor was closed +-- The STM action will throw an 'Prelude.IOError' if the file descriptor was closed -- while the STM action is being executed. To safely close a file descriptor -- that has been used with 'threadWaitWriteSTM', use 'closeFdWith'. threadWaitWriteSTM :: Fd -> IO (STM (), IO ()) |