From 6c1a1d9b07427d9d5aa2b15206d98c756bef4b19 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E4=BD=A0=E5=A5=BD-=E8=82=9A=E8=B4=A2?=
 <rustin.liu@gmail.com>
Date: Sat, 25 Sep 2021 22:04:38 +0800
Subject: [PATCH] docs: add returning on the first error example for try_join!
 (#4133)

---
 tokio/src/macros/try_join.rs | 39 ++++++++++++++++++++++++++++++++++++
 1 file changed, 39 insertions(+)

diff --git a/tokio/src/macros/try_join.rs b/tokio/src/macros/try_join.rs
index fa5850ef0..454dbfe4b 100644
--- a/tokio/src/macros/try_join.rs
+++ b/tokio/src/macros/try_join.rs
@@ -59,6 +59,45 @@
 ///     }
 /// }
 /// ```
+///
+/// Using `try_join!` with spawned tasks.
+///
+/// ```
+/// use tokio::task::JoinHandle;
+///
+/// async fn do_stuff_async() -> Result<(), &'static str> {
+///     // async work
+/// # Err("failed")
+/// }
+///
+/// async fn more_async_work() -> Result<(), &'static str> {
+///     // more here
+/// # Ok(())
+/// }
+///
+/// async fn flatten<T>(handle: JoinHandle<Result<T, &'static str>>) -> Result<T, &'static str> {
+///     match handle.await {
+///         Ok(Ok(result)) => Ok(result),
+///         Ok(Err(err)) => Err(err),
+///         Err(err) => Err("handling failed"),
+///     }
+/// }
+///
+/// #[tokio::main]
+/// async fn main() {
+///     let handle1 = tokio::spawn(do_stuff_async());
+///     let handle2 = tokio::spawn(more_async_work());
+///     match tokio::try_join!(flatten(handle1), flatten(handle2)) {
+///         Ok(val) => {
+///             // do something with the values
+///         }
+///         Err(err) => {
+///             println!("Failed with {}.", err);
+///             # assert_eq!(err, "failed");
+///         }
+///     }
+/// }
+/// ```
 #[macro_export]
 #[cfg_attr(docsrs, doc(cfg(feature = "macros")))]
 macro_rules! try_join {