From ede73f9463bde50e5b89ccab13f1b405b77544a4 Mon Sep 17 00:00:00 2001
From: Jaremy Creechley <creechley@gmail.com>
Date: Wed, 14 Feb 2024 22:07:57 -0700
Subject: [PATCH] docs

---
 src/apatheia/queues.nim | 1 +
 1 file changed, 1 insertion(+)

diff --git a/src/apatheia/queues.nim b/src/apatheia/queues.nim
index 9efbcec..84a0157 100644
--- a/src/apatheia/queues.nim
+++ b/src/apatheia/queues.nim
@@ -26,6 +26,7 @@ proc destroy*[T](val: SignalQueue[T]) =
   discard val.signal.close()
 
 proc newSignalQueue*[T](maxItems: int = 0): SignalQueue[T] {.raises: [ApatheiaSignalErr].} =
+  ## Create a signal queue compatible with Chronos async
   let res = ThreadSignalPtr.new()
   if res.isErr():
     raise newException(ApatheiaSignalErr, res.error())