diff options
| author | Igor Aleksanov <popzxc@yandex.ru> | 2020-09-05 21:22:47 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-09-05 20:22:47 +0200 |
| commit | 38cab933301b60a7fa730bb999bc08cdb5529476 (patch) | |
| tree | 7e1bd785ca4a0c9ec565717fa4d4d75180523504 /tokio-macros | |
| parent | 171cb57fa1baffe369e44e1bf28382dcb54b2e1c (diff) | |
runtime: improve runtime vs #[tokio::main] doc (#2820)
Diffstat (limited to 'tokio-macros')
| -rw-r--r-- | tokio-macros/src/lib.rs | 14 |
1 files changed, 12 insertions, 2 deletions
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: /// |