Merge pull request #131 from yoshuawuyts/future-docs

update future docs

src/future/join/array.rs

@@ -10,7 +10,7 @@ use core::task::{Context, Poll};
 
 use pin_project::{pin_project, pinned_drop};
 
-/// Waits for two similarly-typed futures to complete.
+/// A future which waits for two similarly-typed futures to complete.
 ///
 /// This `struct` is created by the [`join`] method on the [`Join`] trait. See
 /// its documentation for more.

src/future/join/tuple.rs

@@ -57,7 +57,7 @@ macro_rules! drop_outputs {
 
 macro_rules! impl_join_tuple {
     ($mod_name:ident $StructName:ident) => {
-        /// Waits for two similarly-typed futures to complete.
+        /// A future which waits for two similarly-typed futures to complete.
         ///
         /// This `struct` is created by the [`join`] method on the [`Join`] trait. See
         /// its documentation for more.

src/future/join/vec.rs

@@ -10,7 +10,7 @@ use std::vec::Vec;
 
 use pin_project::{pin_project, pinned_drop};
 
-/// Waits for two similarly-typed futures to complete.
+/// A future which waits for two similarly-typed futures to complete.
 ///
 /// This `struct` is created by the [`join`] method on the [`Join`] trait. See
 /// its documentation for more.

src/future/race/array.rs

@@ -9,7 +9,7 @@ use core::task::{Context, Poll};
 
 use pin_project::pin_project;
 
-/// Wait for the first future to complete.
+/// A future which waits for the first future to complete.
 ///
 /// This `struct` is created by the [`race`] method on the [`Race`] trait. See
 /// its documentation for more.

src/future/race/tuple.rs

@@ -10,7 +10,7 @@ use pin_project::pin_project;
 
 macro_rules! impl_race_tuple {
     ($StructName:ident $($F:ident)+) => {
-        /// Wait for the first future to complete.
+        /// A future which waits for the first future to complete.
         ///
         /// This `struct` is created by the [`race`] method on the [`Race`] trait. See
         /// its documentation for more.

src/future/race/vec.rs

@@ -9,7 +9,7 @@ use core::task::{Context, Poll};
 
 use pin_project::pin_project;
 
-/// Wait for the first future to complete.
+/// A future which waits for the first future to complete.
 ///
 /// This `struct` is created by the [`race`] method on the [`Race`] trait. See
 /// its documentation for more.

src/future/race_ok/array/mod.rs

@@ -15,7 +15,7 @@ mod error;
 
 pub use error::AggregateError;
 
-/// Wait for the first successful future to complete.
+/// A future which waits for the first successful future to complete.
 ///
 /// This `struct` is created by the [`race_ok`] method on the [`RaceOk`] trait. See
 /// its documentation for more.

src/future/race_ok/tuple/mod.rs

@@ -21,7 +21,7 @@ macro_rules! impl_race_ok_tuple {
         #[allow(non_upper_case_globals)]
         const $StructName: usize = utils::tuple_len!($($F,)*);
 
-        /// Wait for the first successful future to complete.
+        /// A future which waits for the first successful future to complete.
         ///
         /// This `struct` is created by the [`race_ok`] method on the [`RaceOk`] trait. See
         /// its documentation for more.

src/future/race_ok/vec/mod.rs

@@ -14,7 +14,7 @@ pub use error::AggregateError;
 
 mod error;
 
-/// Wait for the first successful future to complete.
+/// A future which waits for the first successful future to complete.
 ///
 /// This `struct` is created by the [`race_ok`] method on the [`RaceOk`] trait. See
 /// its documentation for more.

src/future/try_join/array.rs

@@ -8,7 +8,7 @@ use core::task::{Context, Poll};
 
 use pin_project::pin_project;
 
-/// Wait for all futures to complete successfully, or abort early on error.
+/// A future which waits for all futures to complete successfully, or abort early on error.
 ///
 /// This `struct` is created by the [`try_join`] method on the [`TryJoin`] trait. See
 /// its documentation for more.

src/future/try_join/tuple.rs

@@ -38,7 +38,7 @@ macro_rules! impl_try_join_tuple {
             pub(super) const LEN: usize = [$(Indexes::$F,)+].len();
         }
 
-        /// Wait for all futures to complete successfully, or abort early on error.
+        /// A future which waits for all futures to complete successfully, or abort early on error.
         ///
         /// This `struct` is created by the [`try_join`] method on the [`TryJoin`] trait. See
         /// its documentation for more.

src/future/try_join/vec.rs

@@ -10,7 +10,7 @@ use core::task::{Context, Poll};
 use std::boxed::Box;
 use std::vec::Vec;
 
-/// Wait for all futures to complete successfully, or abort early on error.
+/// A future which waits for all futures to complete successfully, or abort early on error.
 ///
 /// This `struct` is created by the [`try_join`] method on the [`TryJoin`] trait. See
 /// its documentation for more.