From 80f03581193f4bc5850425318bb9bf69bbeb5520 Mon Sep 17 00:00:00 2001
From: seanses <di@huggingface.co>
Date: Thu, 13 Feb 2025 18:19:41 -0800
Subject: [PATCH] add comments

---
 xet_threadpool/src/threadpool.rs | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/xet_threadpool/src/threadpool.rs b/xet_threadpool/src/threadpool.rs
index 1c2b17b..f2bd424 100644
--- a/xet_threadpool/src/threadpool.rs
+++ b/xet_threadpool/src/threadpool.rs
@@ -177,6 +177,8 @@ impl ThreadPool {
         ret
     }
 
+    /// This function can be safely used by threads inside of tokio to call an async function
+    /// from a sync function.
     pub fn internal_run_async_task<F>(&self, future: F) -> Result<F::Output, MultithreadedRuntimeError>
     where
         F: std::future::Future + Send + 'static,