Skip to content

Commit

Permalink
cleanup spawn_blocking docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Noah-Kennedy committed Oct 2, 2024
1 parent 4ed6f12 commit 381ab8b
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion tokio/src/runtime/local_runtime/runtime.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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
///
Expand Down

0 comments on commit 381ab8b

Please sign in to comment.