From 5658d7c5032ade1bd0b18e3ec5b2b788eeac630e Mon Sep 17 00:00:00 2001 From: Kevin Reid Date: Sun, 25 Feb 2024 13:17:26 -0800 Subject: [PATCH] runtime: add doc link from `Runtime` to `#[tokio::main]` (#6366) --- tokio/src/runtime/runtime.rs | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/tokio/src/runtime/runtime.rs b/tokio/src/runtime/runtime.rs index a8a954280..2bf1636d5 100644 --- a/tokio/src/runtime/runtime.rs +++ b/tokio/src/runtime/runtime.rs @@ -21,8 +21,8 @@ cfg_rt_multi_thread! { /// blocking pool, necessary for running asynchronous tasks. /// /// Instances of `Runtime` can be created using [`new`], or [`Builder`]. -/// However, most users will use the `#[tokio::main]` annotation on their -/// entry point instead. +/// However, most users will use the [`#[tokio::main]`][main] annotation on +/// their entry point instead. /// /// See [module level][mod] documentation for more details. /// @@ -86,6 +86,7 @@ cfg_rt_multi_thread! { /// [`new`]: method@Self::new /// [`Builder`]: struct@Builder /// [`Handle`]: struct@Handle +/// [main]: macro@crate::main /// [`tokio::spawn`]: crate::spawn /// [`Arc::try_unwrap`]: std::sync::Arc::try_unwrap /// [Arc]: std::sync::Arc