Skip to content

Commit a3a740c

Browse files
committed
backlink all docs
Signed-off-by: Yoshua Wuyts <yoshuawuyts@gmail.com>
1 parent 81e3cab commit a3a740c

18 files changed

+88
-7
lines changed

src/stream/empty.rs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,11 @@ use crate::task::{Context, Poll};
66

77
/// Creates a stream that doesn't yield any items.
88
///
9+
/// This `struct` is created by the [`empty`] function. See its
10+
/// documentation for more.
11+
///
12+
/// [`empty`]: fn.empty.html
13+
///
914
/// # Examples
1015
///
1116
/// ```

src/stream/from_fn.rs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,8 @@ use crate::task::{Context, Poll};
1010
pin_project! {
1111
/// A stream that yields elements by calling a closure.
1212
///
13-
/// This stream is constructed by [`from_fn`] function.
13+
/// This stream is created by the [`from_fn`] function. See its
14+
/// documentation for more.
1415
///
1516
/// [`from_fn`]: fn.from_fn.html
1617
#[derive(Debug)]

src/stream/interval.rs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,10 @@ pub fn interval(dur: Duration) -> Interval {
5252

5353
/// A stream representing notifications at fixed interval
5454
///
55+
/// This stream is created by the [`interval`] function. See its
56+
/// documentation for more.
57+
///
58+
/// [`interval`]: fn.interval.html
5559
#[cfg(feature = "unstable")]
5660
#[cfg_attr(feature = "docs", doc(cfg(unstable)))]
5761
#[derive(Debug)]

src/stream/once.rs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,8 @@ pub fn once<T>(t: T) -> Once<T> {
2929
pin_project! {
3030
/// A stream that yields a single item.
3131
///
32-
/// This stream is constructed by the [`once`] function.
32+
/// This stream is created by the [`once`] function. See its
33+
/// documentation for more.
3334
///
3435
/// [`once`]: fn.once.html
3536
#[derive(Debug)]

src/stream/repeat.rs

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,10 @@ where
2929

3030
/// A stream that yields the same item repeatedly.
3131
///
32-
/// This stream is constructed by the [`repeat`] function.
32+
/// This stream is created by the [`repeat`] function. See its
33+
/// documentation for more.
3334
///
34-
/// [`repeat`]: fn.repeat.html
35+
/// [`repeat`]: fn.once.html
3536
#[derive(Debug)]
3637
pub struct Repeat<T> {
3738
item: T,

src/stream/repeat_with.rs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,8 @@ use crate::task::{Context, Poll};
1010
pin_project! {
1111
/// A stream that repeats elements of type `T` endlessly by applying a provided closure.
1212
///
13-
/// This stream is constructed by the [`repeat_with`] function.
13+
/// This stream is created by the [`repeat_with`] function. See its
14+
/// documentation for more.
1415
///
1516
/// [`repeat_with`]: fn.repeat_with.html
1617
#[derive(Debug)]

src/stream/stream/chain.rs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,12 @@ use crate::task::{Context, Poll};
88

99
pin_project! {
1010
/// Chains two streams one after another.
11+
///
12+
/// This `struct` is created by the [`chain`] method on [`Stream`]. See its
13+
/// documentation for more.
14+
///
15+
/// [`chain`]: trait.Stream.html#method.chain
16+
/// [`Stream`]: trait.Stream.html
1117
#[derive(Debug)]
1218
pub struct Chain<S, U> {
1319
#[pin]

src/stream/stream/filter.rs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,12 @@ use crate::task::{Context, Poll};
88

99
pin_project! {
1010
/// A stream to filter elements of another stream with a predicate.
11+
///
12+
/// This `struct` is created by the [`filter`] method on [`Stream`]. See its
13+
/// documentation for more.
14+
///
15+
/// [`filter`]: trait.Stream.html#method.filter
16+
/// [`Stream`]: trait.Stream.html
1117
#[derive(Debug)]
1218
pub struct Filter<S, P, T> {
1319
#[pin]

src/stream/stream/fuse.rs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,12 @@ use crate::task::{Context, Poll};
88
pin_project! {
99
/// A `Stream` that is permanently closed once a single call to `poll` results in
1010
/// `Poll::Ready(None)`, returning `Poll::Ready(None)` for all future calls to `poll`.
11+
///
12+
/// This `struct` is created by the [`fuse`] method on [`Stream`]. See its
13+
/// documentation for more.
14+
///
15+
/// [`fuse`]: trait.Stream.html#method.fuse
16+
/// [`Stream`]: trait.Stream.html
1117
#[derive(Clone, Debug)]
1218
pub struct Fuse<S> {
1319
#[pin]

src/stream/stream/inspect.rs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,12 @@ use crate::task::{Context, Poll};
88

99
pin_project! {
1010
/// A stream that does something with each element of another stream.
11+
///
12+
/// This `struct` is created by the [`inspect`] method on [`Stream`]. See its
13+
/// documentation for more.
14+
///
15+
/// [`inspect`]: trait.Stream.html#method.inspect
16+
/// [`Stream`]: trait.Stream.html
1117
#[derive(Debug)]
1218
pub struct Inspect<S, F, T> {
1319
#[pin]

0 commit comments

Comments
 (0)