From 850c95fbcc618a45efde6d1f6889c14d5b619b77 Mon Sep 17 00:00:00 2001
From: Lucas Kent <rubickent@gmail.com>
Date: Wed, 16 Nov 2022 15:15:30 +1100
Subject: [PATCH] Specify type returned when awaiting a oneshot::Receiver

---
 tokio/src/sync/oneshot.rs | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/tokio/src/sync/oneshot.rs b/tokio/src/sync/oneshot.rs
index f5718dc92f8..7afa1aa4997 100644
--- a/tokio/src/sync/oneshot.rs
+++ b/tokio/src/sync/oneshot.rs
@@ -227,7 +227,7 @@ pub struct Sender<T> {
 /// [`channel`](fn@channel) function.
 ///
 /// This channel has no `recv` method because the receiver itself implements the
-/// [`Future`] trait. To receive a value, `.await` the `Receiver` object directly.
+/// [`Future`] trait. To receive a `Result<T, `[`error::RecvError`]`>`, `.await` the `Receiver` object directly.
 ///
 /// The `poll` method on the `Future` trait is allowed to spuriously return
 /// `Poll::Pending` even if the message has been sent. If such a spurious