summaryrefslogtreecommitdiffstats
path: root/tokio/src/macros
diff options
context:
space:
mode:
authorJeffrey Czyz <jkczyz@gmail.com>2020-02-29 07:17:49 -0800
committerGitHub <noreply@github.com>2020-02-29 07:17:49 -0800
commit17a6f6fabf4e4d84e5d2807f49f22fc2bd1b359c (patch)
tree23b25acc173ab6fe766c9ea64b45e11122dcff25 /tokio/src/macros
parentecc23c084a64188e272e2c1e9e370189358a088b (diff)
macros: fix select! documentation formatting (#2283)
Diffstat (limited to 'tokio/src/macros')
-rw-r--r--tokio/src/macros/select.rs8
1 files changed, 4 insertions, 4 deletions
diff --git a/tokio/src/macros/select.rs b/tokio/src/macros/select.rs
index 30b2b171..51b6fcd6 100644
--- a/tokio/src/macros/select.rs
+++ b/tokio/src/macros/select.rs
@@ -4,7 +4,7 @@
/// The `select!` macro must be used inside of async functions, closures, and
/// blocks.
///
-/// The `select` macro accepts one or more branches with the following pattern:
+/// The `select!` macro accepts one or more branches with the following pattern:
///
/// ```text
/// <pattern> = <async expression> (, if <precondition>)? => <handler>,
@@ -24,7 +24,7 @@
/// expression.
///
/// Additionally, each branch may include an optional `if` precondition. This
-/// precondition is evaluated **before** the <async expression>. If the
+/// precondition is evaluated **before** the `<async expression>`. If the
/// precondition returns `false`, the branch is entirely disabled. This
/// capability is useful when using `select!` within a loop.
///
@@ -41,7 +41,7 @@
/// 4. Once an `<async expression>` returns a value, attempt to apply the value
/// to the provided `<pattern>`, if the pattern matches, evaluate `<handler>`
/// and return. If the pattern **does not** match, disable the current branch
-/// and for the remainder of the current call to `select!. Continue from step 3.
+/// and for the remainder of the current call to `select!`. Continue from step 3.
/// 5. If **all** branches are disabled, evaluate the `else` expression. If none
/// is provided, panic.
///
@@ -210,7 +210,7 @@
/// }
/// ```
///
-/// Using the same future in multiple select! expressions can be done by passing
+/// Using the same future in multiple `select!` expressions can be done by passing
/// a reference to the future. Doing so requires the future to be [`Unpin`]. A
/// future can be made [`Unpin`] by either using [`Box::pin`] or stack pinning.
///