Improve unit_error documentation

Author: Nemo157

futures-util/src/future/mod.rs

@@ -535,7 +535,8 @@ pub trait FutureExt: Future {
         Box::pin(self)
     }
 
-    /// Turns a `Future` into a `TryFuture` with `Error = ()`.
+    /// Turns a [`Future<Output = T>`](Future) into a
+    /// [`TryFuture<Ok = T, Error = ()`>](futures_core::future::TryFuture).
     fn unit_error(self) -> UnitError<Self>
         where Self: Sized
     {

futures-util/src/future/unit_error.rs

@@ -3,9 +3,7 @@ use futures_core::future::{FusedFuture, Future};
 use futures_core::task::{Context, Poll};
 use pin_utils::unsafe_pinned;
 
-/// Future for the `unit_error` combinator, turning a `Future` into a `TryFuture`.
-///
-/// This is created by the `FutureExt::unit_error` method.
+/// Future for the [`unit_error`](super::FutureExt::unit_error) combinator.
 #[derive(Debug)]
 #[must_use = "futures do nothing unless polled"]
 pub struct UnitError<Fut> {
@@ -15,7 +13,6 @@ pub struct UnitError<Fut> {
 impl<Fut> UnitError<Fut> {
     unsafe_pinned!(future: Fut);
 
-    /// Creates a new UnitError.
     pub(super) fn new(future: Fut) -> UnitError<Fut> {
         UnitError { future }
     }

futures/src/lib.rs

@@ -201,7 +201,7 @@ pub mod future {
         OptionFuture,
 
         FutureExt,
-        FlattenStream, Flatten, Fuse, Inspect, IntoStream, Map, Then,
+        FlattenStream, Flatten, Fuse, Inspect, IntoStream, Map, Then, UnitError,
     };
 
     #[cfg(feature = "alloc")]