From bfb4b9c1cb130aa0a9ec5d14436d5f57217fe42b Mon Sep 17 00:00:00 2001
From: Daniel Henry-Mantilla <daniel.henry.mantilla@gmail.com>
Date: Thu, 7 Jul 2022 03:52:12 +0200
Subject: [PATCH] `doc(alias)` `pending()` to `never` (#2613)

It can be legitimately to look for the future that _never_ resolves using the name `never`. This PR ensures `pending()` shows up when making such queries.
---
 futures-util/src/future/pending.rs | 1 +
 1 file changed, 1 insertion(+)

diff --git a/futures-util/src/future/pending.rs b/futures-util/src/future/pending.rs
index 92c78d52b8..b8e28686e1 100644
--- a/futures-util/src/future/pending.rs
+++ b/futures-util/src/future/pending.rs
@@ -33,6 +33,7 @@ impl<T> FusedFuture for Pending<T> {
 /// unreachable!();
 /// # });
 /// ```
+#[cfg_attr(docsrs, doc(alias = "never"))]
 pub fn pending<T>() -> Pending<T> {
     assert_future::<T, _>(Pending { _data: marker::PhantomData })
 }