Skip to content

Commit

Permalink
Fix doc formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
jmorag committed Nov 15, 2021
1 parent 4e01c51 commit e06c362
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion futures-util/src/stream/diff_ascending.rs
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ pub fn diff_ascending<T: Ord, St1: Stream<Item = T>, St2: Stream<Item = T>>(
}

pin_project! {
/// Struct for the `diff_ascending` method.
/// Struct for the [`diff_ascending`] method.
#[derive(Debug)]
#[must_use = "streams do nothing unless polled"]
pub struct DiffAscending<T, St1: Stream<Item = T>, St2: Stream<Item = T>> {
Expand Down
2 changes: 1 addition & 1 deletion futures-util/src/stream/merge_ascending.rs
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ pub fn merge_ascending<T: Ord, St1: Stream<Item = T>, St2: Stream<Item = T>>(
}

pin_project! {
/// Struct for the `merge_ascending` method.
/// Struct for the [`merge_ascending`] method.
#[derive(Debug)]
#[must_use = "streams do nothing unless polled"]
pub struct MergeAscending<T, St1: Stream<Item = T>, St2: Stream<Item = T>> {
Expand Down
2 changes: 1 addition & 1 deletion futures-util/src/stream/merge_multiple_ascending.rs
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ use pin_project_lite::pin_project;
/// # });
/// ```
///
/// NOTE: this is not as easy to use as `merge_ascending`. Every stream in the
/// NOTE: this is not as easy to use as [`merge_ascending`](futures::stream::merge_asceding). Every stream in the
/// iterator must be `Unpin` and have _exactly_ the same type as opposed to the
/// two stream case where both streams need only implement the `Stream<Item =
/// T>` trait. In practice, you will likely need to Box your streams into a
Expand Down

0 comments on commit e06c362

Please sign in to comment.