Skip to content

Commit 506449f

Browse files
committed
Improve AsyncResult doc
1 parent 041238d commit 506449f

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

lightning/src/util/async_poll.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -93,10 +93,10 @@ pub(crate) fn dummy_waker() -> Waker {
9393
}
9494

9595
#[cfg(feature = "std")]
96-
/// A type alias for a future that returns a result of type T.
96+
/// A type alias for a future that returns a result of type `T` or error `E`.
9797
pub type AsyncResult<'a, T, E> = Pin<Box<dyn Future<Output = Result<T, E>> + 'a + Send>>;
9898
#[cfg(not(feature = "std"))]
99-
/// A type alias for a future that returns a result of type T.
99+
/// A type alias for a future that returns a result of type `T` or error `E`.
100100
pub type AsyncResult<'a, T, E> = Pin<Box<dyn Future<Output = Result<T, E>> + 'a>>;
101101

102102
/// Marker trait to optionally implement `Sync` under std.

0 commit comments

Comments
 (0)