From 25e16f94759d3bab316a4dfbbb686e20544c8e2c Mon Sep 17 00:00:00 2001
From: Jaremy Creechley <creechley@gmail.com>
Date: Tue, 26 Sep 2023 20:41:57 -0700
Subject: [PATCH] docs

---
 datastore/threads/threadproxyds.nim | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/datastore/threads/threadproxyds.nim b/datastore/threads/threadproxyds.nim
index ae14782..2583d2c 100644
--- a/datastore/threads/threadproxyds.nim
+++ b/datastore/threads/threadproxyds.nim
@@ -48,10 +48,12 @@ type
   TaskCtxObj*[T: ThreadTypes] = object
     res: ThreadResult[T]
     signal: ThreadSignalPtr
-    running: bool
-    cancelled: bool
+    running: bool ## used to mark when a task worker is running
+    cancelled: bool ## used to cancel a task before it's started
 
   TaskCtx*[T] = SharedPtr[TaskCtxObj[T]]
+    ## Task context object.
+    ## This is a SharedPtr to make the query iter simpler
 
   ThreadDatastore* = ref object of Datastore
     tp: Taskpool