Enhance documentation of tokio::task::block_in_place (#2155)

1 files changed, 6 insertions, 0 deletions

diff --git a/tokio/src/task/blocking.rs b/tokio/src/task/blocking.rs
index a155197f..69f4cf0a 100644
--- a/tokio/src/task/blocking.rs
+++ b/tokio/src/task/blocking.rs
@@ -10,6 +10,12 @@ cfg_rt_threaded! {
     /// (possibly new) thread, and only then poll the task. Note that this requires
     /// additional synchronization.
     ///
+    /// # Note
+    ///
+    /// This function can only be called from a spawned task when working with
+    /// the [threaded scheduler](https://docs.rs/tokio/0.2.10/tokio/runtime/index.html#threaded-scheduler).
+    /// Consider using [tokio::task::spawn_blocking](https://docs.rs/tokio/0.2.10/tokio/task/fn.spawn_blocking.html).
+    ///
     /// # Examples
     ///
     /// ```