From e363554866169d8dcfcbab37ce9b8624eb0ac8be Mon Sep 17 00:00:00 2001 From: Jens Nolte <git@queezle.net> Date: Sun, 29 Aug 2021 21:48:47 +0200 Subject: [PATCH] Documentation --- src/Quasar/Async.hs | 3 +-- src/Quasar/Awaitable.hs | 2 +- src/Quasar/Timer.hs | 8 -------- 3 files changed, 2 insertions(+), 11 deletions(-) diff --git a/src/Quasar/Async.hs b/src/Quasar/Async.hs index 3aa9c21..457828b 100644 --- a/src/Quasar/Async.hs +++ b/src/Quasar/Async.hs @@ -26,11 +26,10 @@ import Quasar.Prelude class (MonadAwait m, MonadResourceManager m, MonadMask m) => MonadAsync m where - -- | TODO async :: m r -> m (Task r) async action = asyncWithUnmask ($ action) - -- | TODO + -- | TODO: Documentation -- -- The action will be run with asynchronous exceptions masked and will be passed an action that can be used unmask. asyncWithUnmask :: ((forall a. m a -> m a) -> m r) -> m (Task r) diff --git a/src/Quasar/Awaitable.hs b/src/Quasar/Awaitable.hs index 930fd6f..b63d55e 100644 --- a/src/Quasar/Awaitable.hs +++ b/src/Quasar/Awaitable.hs @@ -1,8 +1,8 @@ module Quasar.Awaitable ( -- * Awaitable + MonadAwait(..), IsAwaitable(..), Awaitable, - MonadAwait(..), awaitResult, peekAwaitable, successfulAwaitable, diff --git a/src/Quasar/Timer.hs b/src/Quasar/Timer.hs index 6ffb81c..9f6cebf 100644 --- a/src/Quasar/Timer.hs +++ b/src/Quasar/Timer.hs @@ -9,7 +9,6 @@ module Quasar.Timer ( newTimerScheduler, TimerCancelled, - NegativeTimeJump, Delay, newDelay, @@ -33,13 +32,6 @@ data TimerCancelled = TimerCancelled instance Exception TimerCancelled -data NegativeTimeJump = NegativeTimeJump - deriving stock (Eq, Show) - -instance Exception NegativeTimeJump - - - data Timer = Timer { key :: Unique, time :: UTCTime, -- GitLab