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

---
 src/apatheia/queues.nim | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/src/apatheia/queues.nim b/src/apatheia/queues.nim
index 84a0157..4c3cd0b 100644
--- a/src/apatheia/queues.nim
+++ b/src/apatheia/queues.nim
@@ -21,12 +21,13 @@ type
     signal: ThreadSignalPtr
     chan*: ChanPtr[T]
 
-proc destroy*[T](val: SignalQueue[T]) =
+proc dispose*[T](val: SignalQueue[T]) =
+  ## Call to properly dispose of a SignalQueue.
   deallocShared(val.chan)
   discard val.signal.close()
 
 proc newSignalQueue*[T](maxItems: int = 0): SignalQueue[T] {.raises: [ApatheiaSignalErr].} =
-  ## Create a signal queue compatible with Chronos async
+  ## Create a signal queue compatible with Chronos async.
   let res = ThreadSignalPtr.new()
   if res.isErr():
     raise newException(ApatheiaSignalErr, res.error())