summaryrefslogtreecommitdiffstats
path: root/tokio/src/lib.rs
diff options
context:
space:
mode:
authorIgor Aleksanov <popzxc@yandex.ru>2020-09-05 21:22:47 +0300
committerGitHub <noreply@github.com>2020-09-05 20:22:47 +0200
commit38cab933301b60a7fa730bb999bc08cdb5529476 (patch)
tree7e1bd785ca4a0c9ec565717fa4d4d75180523504 /tokio/src/lib.rs
parent171cb57fa1baffe369e44e1bf28382dcb54b2e1c (diff)
runtime: improve runtime vs #[tokio::main] doc (#2820)
Diffstat (limited to 'tokio/src/lib.rs')
-rw-r--r--tokio/src/lib.rs7
1 files changed, 4 insertions, 3 deletions
diff --git a/tokio/src/lib.rs b/tokio/src/lib.rs
index 7bf9f743..b31b478d 100644
--- a/tokio/src/lib.rs
+++ b/tokio/src/lib.rs
@@ -196,9 +196,10 @@
//!
//! Finally, Tokio provides a _runtime_ for executing asynchronous tasks. Most
//! applications can use the [`#[tokio::main]`][main] macro to run their code on the
-//! Tokio runtime. In use-cases where manual control over the runtime is
-//! required, the [`tokio::runtime`] module provides APIs for configuring and
-//! managing runtimes.
+//! Tokio runtime. However, this macro provides only basic configuration options. As
+//! an alternative, the [`tokio::runtime`] module provides more powerful APIs for configuring
+//! and managing runtimes. You should use that module if the `#[tokio::main]` macro doesn't
+//! provide the functionality you need.
//!
//! Using the runtime requires the "rt-core" or "rt-threaded" feature flags, to
//! enable the basic [single-threaded scheduler][rt-core] and the [thread-pool