From 65a6a3088608500c6418ea5c9d4e6c4bbf1a95cc Mon Sep 17 00:00:00 2001
From: Jens Nolte <git@queezle.net>
Date: Tue, 31 Aug 2021 20:02:37 +0200
Subject: [PATCH] Add documentation for runUnlimitedAsync

---
 src/Quasar/Async.hs | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/src/Quasar/Async.hs b/src/Quasar/Async.hs
index 42d892c..e0fd507 100644
--- a/src/Quasar/Async.hs
+++ b/src/Quasar/Async.hs
@@ -97,6 +97,8 @@ instance MonadAsync UnlimitedAsync where
         liftIO $ unmask $ runReaderT action resourceManager
 
 
+-- | Run a computation in `MonadAsync` where `async` is implemented without any thread limits (i.e. every `async` will
+-- fork a new (RTS) thread).
 runUnlimitedAsync :: (MonadResourceManager m) => (forall f. MonadAsync f => f r) -> m r
 runUnlimitedAsync action = do
   resourceManager <- askResourceManager
-- 
GitLab