From 381ab8b6417270e9655a962b5f4d19601325bc0d Mon Sep 17 00:00:00 2001 From: Noah Kennedy Date: Wed, 2 Oct 2024 15:02:52 -0500 Subject: [PATCH] cleanup spawn_blocking docs --- tokio/src/runtime/local_runtime/runtime.rs | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/tokio/src/runtime/local_runtime/runtime.rs b/tokio/src/runtime/local_runtime/runtime.rs index 23a07ffc255..073d428b8ad 100644 --- a/tokio/src/runtime/local_runtime/runtime.rs +++ b/tokio/src/runtime/local_runtime/runtime.rs @@ -149,7 +149,13 @@ impl LocalRuntime { } } - /// Runs the provided function on an executor dedicated to blocking operations. + /// Runs the provided function on a thread from a dedicated blocking thread pool. + /// + /// This function _will_ be run on another thread. + /// + /// See the documentation in the non-local runtime for more information. + /// + /// [Runtime]: crate::runtime::Runtime::spawn_blocking /// /// # Examples ///