Skip to content

Commit cdc8795

Browse files
committed
MonadAsync: expanded haddocks of linkTo and linkToOnly
1 parent 736aacb commit cdc8795

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

io-classes/src/Control/Monad/Class/MonadAsync.hs

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -433,10 +433,17 @@ link2Only shouldThrow left right =
433433
tr = asyncThreadId right
434434

435435
-- | Generalization of 'link' that links an async to an arbitrary thread.
436+
--
437+
-- Non standard (not in 'async' library)
438+
--
436439
linkTo :: (MonadAsync m, MonadFork m, MonadMask m)
437440
=> ThreadId m -> Async m a -> m ()
438441
linkTo tid = linkToOnly tid (not . isCancel)
439442

443+
-- | Generalization of 'linkOnly' that links an async to an arbitrary thread.
444+
--
445+
-- Non standard (not in 'async' library).
446+
--
440447
linkToOnly :: forall m a. (MonadAsync m, MonadFork m, MonadMask m)
441448
=> ThreadId m -> (SomeException -> Bool) -> Async m a -> m ()
442449
linkToOnly tid shouldThrow a = do

0 commit comments

Comments
 (0)