summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRajiv Chauhan <rajiv.chauhan@gmail.com>2020-11-26 13:46:15 -0500
committerGitHub <noreply@github.com>2020-11-26 19:46:15 +0100
commit5e406a7a47699d93fa2a77fb72553600cb7abd0f (patch)
treeac6898684e4b84e4a5d0e781adf42d950bbc9e43
parentde33ee85ce61377b316b630e4355d419cc4abcb7 (diff)
macros: fix outdated documentation (#3180)
1. Changed 0.2 to 0.3 2. Changed ‘multi’ to ‘single’ to indicate that the behavior is single threaded
-rw-r--r--tokio-macros/src/lib.rs18
1 files changed, 9 insertions, 9 deletions
diff --git a/tokio-macros/src/lib.rs b/tokio-macros/src/lib.rs
index 51722582..71c61e72 100644
--- a/tokio-macros/src/lib.rs
+++ b/tokio-macros/src/lib.rs
@@ -138,8 +138,8 @@ use proc_macro::TokenStream;
/// ### NOTE:
///
/// If you rename the tokio crate in your dependencies this macro will not work.
-/// If you must rename the 0.2 version of tokio because you're also using the
-/// 0.1 version of tokio, you _must_ make the tokio 0.2 crate available as
+/// If you must rename the 0.3 version of tokio because you're also using the
+/// 0.1 version of tokio, you _must_ make the tokio 0.3 crate available as
/// `tokio` in the module where this macro is expanded.
#[proc_macro_attribute]
#[cfg(not(test))] // Work around for rust-lang/rust#62127
@@ -183,9 +183,9 @@ pub fn main(args: TokenStream, item: TokenStream) -> TokenStream {
/// ### NOTE:
///
/// If you rename the tokio crate in your dependencies this macro
-/// will not work. If you must rename the 0.2 version of tokio because
+/// will not work. If you must rename the 0.3 version of tokio because
/// you're also using the 0.1 version of tokio, you _must_ make the
-/// tokio 0.2 crate available as `tokio` in the module where this
+/// tokio 0.3 crate available as `tokio` in the module where this
/// macro is expanded.
#[proc_macro_attribute]
#[cfg(not(test))] // Work around for rust-lang/rust#62127
@@ -208,7 +208,7 @@ pub fn main_rt(args: TokenStream, item: TokenStream) -> TokenStream {
///
/// ### Using default
///
-/// The default test runtime is multi-threaded.
+/// The default test runtime is single-threaded.
///
/// ```no_run
/// #[tokio::test]
@@ -220,9 +220,9 @@ pub fn main_rt(args: TokenStream, item: TokenStream) -> TokenStream {
/// ### NOTE:
///
/// If you rename the tokio crate in your dependencies this macro
-/// will not work. If you must rename the 0.2 version of tokio because
+/// will not work. If you must rename the 0.3 version of tokio because
/// you're also using the 0.1 version of tokio, you _must_ make the
-/// tokio 0.2 crate available as `tokio` in the module where this
+/// tokio 0.3 crate available as `tokio` in the module where this
/// macro is expanded.
#[proc_macro_attribute]
pub fn test(args: TokenStream, item: TokenStream) -> TokenStream {
@@ -243,9 +243,9 @@ pub fn test(args: TokenStream, item: TokenStream) -> TokenStream {
/// ### NOTE:
///
/// If you rename the tokio crate in your dependencies this macro
-/// will not work. If you must rename the 0.2 version of tokio because
+/// will not work. If you must rename the 0.3 version of tokio because
/// you're also using the 0.1 version of tokio, you _must_ make the
-/// tokio 0.2 crate available as `tokio` in the module where this
+/// tokio 0.3 crate available as `tokio` in the module where this
/// macro is expanded.
#[proc_macro_attribute]
pub fn test_rt(args: TokenStream, item: TokenStream) -> TokenStream {