From 76590e646774f69eaf5de06780ad3e4be2a9b2e5 Mon Sep 17 00:00:00 2001 From: Daniel Henry-Mantilla 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 FusedFuture for Pending { /// unreachable!(); /// # }); /// ``` +#[cfg_attr(docsrs, doc(alias = "never"))] pub fn pending() -> Pending { assert_future::(Pending { _data: marker::PhantomData }) }