doc(alias) pending() to never (#2613)

danielhenrymantilla · web-flow · commit bfb4b9c1cb13 · 2022-07-07T10:52:12.000+09:00
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.
diff --git 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 })
 }

Original file line number	Diff line number	Diff line change
`@@ -33,6 +33,7 @@ impl<T> FusedFuture for Pending<T> {`
`33`	`33`	`/// unreachable!();`
`34`	`34`	`/// # });`
`35`	`35`	/// ```
	`36`	`+#[cfg_attr(docsrs, doc(alias = "never"))]`
`36`	`37`	`pub fn pending<T>() -> Pending<T> {`
`37`	`38`	`assert_future::<T, _>(Pending { _data: marker::PhantomData })`
`38`	`39`	`}`