runtime: fix unclear docs for {Handle,Runtime}::block_on (#3628)

tokio-rs · Mar 20, 2021 · 0bfcbc8 · 0bfcbc8
1 parent 81f47e8
commit 0bfcbc8
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/tokio/src/runtime/handle.rs b/tokio/src/runtime/handle.rs
@@ -205,7 +205,7 @@ impl Handle {
 
     /// Run a future to completion on this `Handle`'s associated `Runtime`.
     ///
-    /// This runs the given future on the runtime, blocking until it is
+    /// This runs the given future on the current thread, blocking until it is
     /// complete, and yielding its resolved result. Any tasks or timers which
     /// the future spawns internally will be executed on the runtime.
     ///

diff --git a/tokio/src/runtime/mod.rs b/tokio/src/runtime/mod.rs
@@ -405,7 +405,7 @@ cfg_rt! {
         /// Run a future to completion on the Tokio runtime. This is the
         /// runtime's entry point.
         ///
-        /// This runs the given future on the runtime, blocking until it is
+        /// This runs the given future on the current thread, blocking until it is
         /// complete, and yielding its resolved result. Any tasks or timers
         /// which the future spawns internally will be executed on the runtime.
         ///