Skip to content

Commit a0c9fd5

Browse files
authored
Fix rustdoc::broken_intra_doc_links warning (#2602)
``` error: unresolved link to `select` --> futures-util/src/future/try_future/mod.rs:272:17 | 272 | /// using [`select!`] or [`join!`]. | ^^^^^^^ no item named `select` in scope | = note: `-D rustdoc::broken-intra-doc-links` implied by `-D warnings` = note: `macro_rules` named `select` exists in this crate, but it is not in scope at this link's location error: unresolved link to `join` --> futures-util/src/future/try_future/mod.rs:272:32 | 272 | /// using [`select!`] or [`join!`]. | ^^^^^ no item named `join` in scope | = note: `macro_rules` named `join` exists in this crate, but it is not in scope at this link's location error: unresolved link to `select` --> futures-util/src/future/try_future/mod.rs:320:27 | 320 | /// type when using [`select!`] or [`join!`]. | ^^^^^^^ no item named `select` in scope | = note: `macro_rules` named `select` exists in this crate, but it is not in scope at this link's location error: unresolved link to `join` --> futures-util/src/future/try_future/mod.rs:320:42 | 320 | /// type when using [`select!`] or [`join!`]. | ^^^^^ no item named `join` in scope | = note: `macro_rules` named `join` exists in this crate, but it is not in scope at this link's location error: unresolved link to `select` --> futures-util/src/stream/stream/mod.rs:1802:15 | 1802 | /// the [`select!`] macro. | ^^^^^^^ no item named `select` in scope | = note: `macro_rules` named `select` exists in this crate, but it is not in scope at this link's location ```
1 parent 657264d commit a0c9fd5

File tree

2 files changed

+8
-0
lines changed

2 files changed

+8
-0
lines changed

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -302,6 +302,9 @@ pub trait TryFutureExt: TryFuture {
302302
/// assert_eq!(future.await, Ok(1));
303303
/// # });
304304
/// ```
305+
///
306+
/// [`join!`]: crate::join
307+
/// [`select!`]: crate::select
305308
fn map_err<E, F>(self, f: F) -> MapErr<Self, F>
306309
where
307310
F: FnOnce(Self::Error) -> E,
@@ -332,6 +335,9 @@ pub trait TryFutureExt: TryFuture {
332335
/// let future_err_i32 = future_err_u8.err_into::<i32>();
333336
/// # });
334337
/// ```
338+
///
339+
/// [`join!`]: crate::join
340+
/// [`select!`]: crate::select
335341
fn err_into<E>(self) -> ErrInto<Self, E>
336342
where
337343
Self: Sized,

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1839,6 +1839,8 @@ pub trait StreamExt: Stream {
18391839
/// assert_eq!(total, 6);
18401840
/// # });
18411841
/// ```
1842+
///
1843+
/// [`select!`]: crate::select
18421844
fn select_next_some(&mut self) -> SelectNextSome<'_, Self>
18431845
where
18441846
Self: Unpin + FusedStream,

0 commit comments

Comments
 (0)