Skip to content

Commit df6353e

Browse files
b3t33John Doe
and
John Doe
authored
Fix some typos in doc-comments (#2354)
Co-authored-by: John Doe <mail@example.com>
1 parent 18e46e8 commit df6353e

File tree

5 files changed

+7
-7
lines changed

5 files changed

+7
-7
lines changed

futures-util/src/async_await/join_mod.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ macro_rules! document_join_macro {
88
/// of all results once complete.
99
///
1010
/// While `join!(a, b)` is similar to `(a.await, b.await)`,
11-
/// `join!` polls both futures concurrently and therefore is more efficent.
11+
/// `join!` polls both futures concurrently and therefore is more efficient.
1212
///
1313
/// This macro is only usable inside of async functions, closures, and blocks.
1414
/// It is also gated behind the `async-await` feature of this library, which is

futures-util/src/future/try_future/mod.rs

+3-3
Original file line numberDiff line numberDiff line change
@@ -539,7 +539,7 @@ pub trait TryFutureExt: TryFuture {
539539
))
540540
}
541541

542-
/// Unwraps this future's ouput, producing a future with this future's
542+
/// Unwraps this future's output, producing a future with this future's
543543
/// [`Ok`](TryFuture::Ok) type as its
544544
/// [`Output`](std::future::Future::Output) type.
545545
///
@@ -569,8 +569,8 @@ pub trait TryFutureExt: TryFuture {
569569
assert_future::<Self::Ok, _>(UnwrapOrElse::new(self, f))
570570
}
571571

572-
/// Wraps a [`TryFuture`] into a future compatable with libraries using
573-
/// futures 0.1 future definitons. Requires the `compat` feature to enable.
572+
/// Wraps a [`TryFuture`] into a future compatible with libraries using
573+
/// futures 0.1 future definitions. Requires the `compat` feature to enable.
574574
#[cfg(feature = "compat")]
575575
#[cfg_attr(docsrs, doc(cfg(feature = "compat")))]
576576
fn compat(self) -> Compat<Self>

futures-util/src/future/try_join.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ generate! {
108108
///
109109
/// This function will return a new future which awaits both futures to
110110
/// complete. If successful, the returned future will finish with a tuple of
111-
/// both results. If unsuccesful, it will complete with the first error
111+
/// both results. If unsuccessful, it will complete with the first error
112112
/// encountered.
113113
///
114114
/// Note that this function consumes the passed futures and returns a

futures-util/src/sink/close.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ impl<Si: Unpin + ?Sized, Item> Unpin for Close<'_, Si, Item> {}
1616

1717
/// A future that completes when the sink has finished closing.
1818
///
19-
/// The sink itself is returned after closeing is complete.
19+
/// The sink itself is returned after closing is complete.
2020
impl<'a, Si: Sink<Item> + Unpin + ?Sized, Item> Close<'a, Si, Item> {
2121
pub(super) fn new(sink: &'a mut Si) -> Self {
2222
Self {

futures-util/src/stream/stream/mod.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -795,7 +795,7 @@ pub trait StreamExt: Stream {
795795
/// this stream combinator will always return that the stream is done.
796796
///
797797
/// The stopping future may return any type. Once the stream is stopped
798-
/// the result of the stopping future may be aceessed with `TakeUntil::take_result()`.
798+
/// the result of the stopping future may be accessed with `TakeUntil::take_result()`.
799799
/// The stream may also be resumed with `TakeUntil::take_future()`.
800800
/// See the documentation of [`TakeUntil`] for more information.
801801
///

0 commit comments

Comments
 (0)