From 38cab933301b60a7fa730bb999bc08cdb5529476 Mon Sep 17 00:00:00 2001 From: Igor Aleksanov Date: Sat, 5 Sep 2020 21:22:47 +0300 Subject: runtime: improve runtime vs #[tokio::main] doc (#2820) --- tokio-macros/src/lib.rs | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) (limited to 'tokio-macros') diff --git a/tokio-macros/src/lib.rs b/tokio-macros/src/lib.rs index 79d06a70..09733ba5 100644 --- a/tokio-macros/src/lib.rs +++ b/tokio-macros/src/lib.rs @@ -26,7 +26,12 @@ use proc_macro::TokenStream; /// Marks async function to be executed by selected runtime. This macro helps set up a `Runtime` /// without requiring the user to use [Runtime](../tokio/runtime/struct.Runtime.html) or -/// [Builder](../tokio/runtime/struct.builder.html) directly. +/// [Builder](../tokio/runtime/struct.Builder.html) directly. +/// +/// Note: This macro is designed to be simplistic and targets applications that do not require +/// a complex setup. If provided functionality is not sufficient, user may be interested in +/// using [Builder](../tokio/runtime/struct.Builder.html), which provides a more powerful +/// interface. /// /// ## Options: /// @@ -133,7 +138,12 @@ pub fn main_threaded(args: TokenStream, item: TokenStream) -> TokenStream { /// Marks async function to be executed by selected runtime. This macro helps set up a `Runtime` /// without requiring the user to use [Runtime](../tokio/runtime/struct.Runtime.html) or -/// [Builder](../tokio/runtime/struct.builder.html) directly. +/// [Builder](../tokio/runtime/struct.Builder.html) directly. +/// +/// Note: This macro is designed to be simplistic and targets applications that do not require +/// a complex setup. If provided functionality is not sufficient, user may be interested in +/// using [Builder](../tokio/runtime/struct.Builder.html), which provides a more powerful +/// interface. /// /// ## Options: /// -- cgit v1.2.3