Skip to content

Fix documentation of Control.Concurrent.Async.Warden.shutdown #183

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
sol wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fix documentation of Control.Concurrent.Async.Warden.shutdown #183

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions Control/Concurrent/Async/Warden.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,10 +54,11 @@ create :: IO Warden
create = Warden <$> newMVar (Just mempty)

-- | Shutdown a 'Warden', calling 'cancel' on all owned threads. Subsequent
-- calls to 'spawn' and 'shutdown' will be no-ops.
--
-- calls to 'spawn' will throw `WardenException`. Subsequent calls to
-- 'shutdown' will be a no-op.
--
-- Note that any exceptions thrown by the threads will be ignored. If you want
-- exceptions to be propagated, either call `wait` explicitly on the 'Async',
-- exceptions to be propagated, either call `wait` explicitly on the 'Async',
-- or use 'link'.
shutdown :: Warden -> IO ()
shutdown (Warden v) = do
Expand Down