From 5540759b01dab881745a08da7302e0460a59a2c2 Mon Sep 17 00:00:00 2001
From: Alice Ryhl <alice@ryhl.io>
Date: Wed, 26 Feb 2020 20:54:44 +0100
Subject: [PATCH] runtime: Add threaded_scheduler to examples

It can be pretty confusing when the core_threads example does not call
threaded_scheduler, when actually building such a runtime results in
panics if you try to spawn something on it:

https://play.rust-lang.org/?version=stable&mode=debug&edition=2018&gist=866b3af344b0d6aad170ac9cbc9d57ed
---
 tokio/src/runtime/builder.rs | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/tokio/src/runtime/builder.rs b/tokio/src/runtime/builder.rs
index d77581a588b..dce265c0393 100644
--- a/tokio/src/runtime/builder.rs
+++ b/tokio/src/runtime/builder.rs
@@ -122,6 +122,7 @@ impl Builder {
     /// use tokio::runtime;
     ///
     /// let rt = runtime::Builder::new()
+    ///     .threaded_scheduler()
     ///     .enable_all()
     ///     .build()
     ///     .unwrap();
@@ -162,6 +163,7 @@ impl Builder {
     /// use tokio::runtime;
     ///
     /// let rt = runtime::Builder::new()
+    ///     .threaded_scheduler()
     ///     .core_threads(4)
     ///     .build()
     ///     .unwrap();
@@ -227,6 +229,7 @@ impl Builder {
     ///
     /// # pub fn main() {
     /// let rt = runtime::Builder::new()
+    ///     .threaded_scheduler()
     ///     .thread_stack_size(32 * 1024)
     ///     .build();
     /// # }
@@ -248,6 +251,7 @@ impl Builder {
     ///
     /// # pub fn main() {
     /// let runtime = runtime::Builder::new()
+    ///     .threaded_scheduler()
     ///     .on_thread_start(|| {
     ///         println!("thread started");
     ///     })
@@ -274,6 +278,7 @@ impl Builder {
     ///
     /// # pub fn main() {
     /// let runtime = runtime::Builder::new()
+    ///     .threaded_scheduler()
     ///     .on_thread_stop(|| {
     ///         println!("thread stopping");
     ///     })
@@ -395,6 +400,11 @@ cfg_rt_core! {
         ///
         /// The executor and all necessary drivers will all be run on the current
         /// thread during `block_on` calls.
+        ///
+        /// See also [the module level documentation][1], which has a section on scheduler
+        /// types.
+        ///
+        /// [1]: index.html#runtime-configurations
         pub fn basic_scheduler(&mut self) -> &mut Self {
             self.kind = Kind::Basic;
             self
@@ -439,6 +449,11 @@ cfg_rt_core! {
 cfg_rt_threaded! {
     impl Builder {
         /// Sets runtime to use a multi-threaded scheduler for executing tasks.
+        ///
+        /// See also [the module level documentation][1], which has a section on scheduler
+        /// types.
+        ///
+        /// [1]: index.html#runtime-configurations
         pub fn threaded_scheduler(&mut self) -> &mut Self {
             self.kind = Kind::ThreadPool;
             self