Skip to content

Commit c6b24ca

Browse files
committed
Fix rustdoc::broken_intra_doc_links warning
``` error: unresolved link to `Box` --> futures-util/src/future/always_ready.rs:43:83 | 43 | /// This is particularly useful in avoiding a heap allocation when an API needs [`Box<dyn Future<Output = T>>`], | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ no item named `Box` in scope | = help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]` = note: `-D rustdoc::broken-intra-doc-links` implied by `-D warnings` = help: to override `-D warnings` add `#[allow(rustdoc::broken_intra_doc_links)]` error: unresolved link to `stream.take` --> futures-util/src/stream/repeat_with.rs:43:7 | 43 | /// [`stream.take()`], in order to make them finite. | ^^^^^^^^^^^^^ no item named `stream.take` in scope | = help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]` error: unresolved link to `stream.repeat` --> futures-util/src/stream/repeat_with.rs:47:11 | 47 | /// the [`stream.repeat()`] function. | ^^^^^^^^^^^^^^^ no item named `stream.repeat` in scope | = help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]` error: unresolved link to `futures-util::stream::select` --> futures-util/src/stream/select_with_strategy.rs:120:46 | 120 | /// Note: this special case is provided by [`futures-util::stream::select`]. | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ no item named `futures-util` in scope ```
1 parent e40bd05 commit c6b24ca

File tree

3 files changed

+4
-4
lines changed

3 files changed

+4
-4
lines changed

futures-util/src/future/always_ready.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ impl<T, F: Fn() -> T> Future for AlwaysReady<T, F> {
4040

4141
/// Creates a future that is always immediately ready with a value.
4242
///
43-
/// This is particularly useful in avoiding a heap allocation when an API needs [`Box<dyn Future<Output = T>>`],
43+
/// This is particularly useful in avoiding a heap allocation when an API needs `Box<dyn Future<Output = T>>`,
4444
/// as [`AlwaysReady`] does not have to store a boolean for `is_finished`.
4545
///
4646
/// # Examples

futures-util/src/stream/repeat_with.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,11 +40,11 @@ impl<A, F: FnMut() -> A> FusedStream for RepeatWith<F> {
4040
/// The `repeat_with()` function calls the repeater over and over again.
4141
///
4242
/// Infinite stream like `repeat_with()` are often used with adapters like
43-
/// [`stream.take()`], in order to make them finite.
43+
/// [`stream.take()`](crate::stream::StreamExt::take), in order to make them finite.
4444
///
4545
/// If the element type of the stream you need implements [`Clone`], and
4646
/// it is OK to keep the source element in memory, you should instead use
47-
/// the [`stream.repeat()`] function.
47+
/// the [`stream::repeat()`](crate::stream::repeat) function.
4848
///
4949
/// # Examples
5050
///

futures-util/src/stream/select_with_strategy.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ pin_project! {
112112
///
113113
/// ### Round Robin
114114
/// This example shows how to select from both streams round robin.
115-
/// Note: this special case is provided by [`futures-util::stream::select`].
115+
/// Note: this special case is provided by [`stream::select`](crate::stream::select).
116116
///
117117
/// ```rust
118118
/// # futures::executor::block_on(async {

0 commit comments

Comments
 (0)