Skip to content

Commit b54b5ee

Browse files
committed
Resolve rustdoc::redundant_explicit_links warning
1 parent 234b74a commit b54b5ee

8 files changed

Lines changed: 20 additions & 26 deletions

File tree

futures-executor/src/enter.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,8 @@ impl std::error::Error for EnterError {}
3434
/// executor.
3535
///
3636
/// Executor implementations should call this function before beginning to
37-
/// execute a task, and drop the returned [`Enter`](Enter) value after
38-
/// completing task execution:
37+
/// execute a task, and drop the returned [`Enter`] value after completing
38+
/// task execution:
3939
///
4040
/// ```
4141
/// use futures::executor::enter;

futures-executor/src/local_pool.rs

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,7 @@ use std::vec::Vec;
2323
/// thread. It's appropriate to poll strictly I/O-bound futures that do very
2424
/// little work in between I/O actions.
2525
///
26-
/// To get a handle to the pool that implements
27-
/// [`Spawn`](futures_task::Spawn), use the
26+
/// To get a handle to the pool that implements [`Spawn`], use the
2827
/// [`spawner()`](LocalPool::spawner) method. Because the executor is
2928
/// single-threaded, it supports a special form of task spawning for non-`Send`
3029
/// futures, via [`spawn_local_obj`](futures_task::LocalSpawn::spawn_local_obj).
@@ -34,7 +33,7 @@ pub struct LocalPool {
3433
incoming: Rc<Incoming>,
3534
}
3635

37-
/// A handle to a [`LocalPool`] that implements [`Spawn`](futures_task::Spawn).
36+
/// A handle to a [`LocalPool`] that implements [`Spawn`].
3837
#[derive(Clone, Debug)]
3938
pub struct LocalSpawner {
4039
incoming: Weak<Incoming>,

futures-executor/src/thread_pool.rs

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -79,17 +79,15 @@ impl ThreadPool {
7979
/// Creates a new thread pool with the default configuration.
8080
///
8181
/// See documentation for the methods in
82-
/// [`ThreadPoolBuilder`](ThreadPoolBuilder) for details on the default
83-
/// configuration.
82+
/// [`ThreadPoolBuilder`] for details on the default configuration.
8483
pub fn new() -> Result<Self, io::Error> {
8584
ThreadPoolBuilder::new().create()
8685
}
8786

8887
/// Create a default thread pool configuration, which can then be customized.
8988
///
9089
/// See documentation for the methods in
91-
/// [`ThreadPoolBuilder`](ThreadPoolBuilder) for details on the default
92-
/// configuration.
90+
/// [`ThreadPoolBuilder`] for details on the default configuration.
9391
pub fn builder() -> ThreadPoolBuilder {
9492
ThreadPoolBuilder::new()
9593
}
@@ -259,7 +257,7 @@ impl ThreadPoolBuilder {
259257
self
260258
}
261259

262-
/// Create a [`ThreadPool`](ThreadPool) with the given configuration.
260+
/// Create a [`ThreadPool`] with the given configuration.
263261
pub fn create(&mut self) -> Result<ThreadPool, io::Error> {
264262
let (tx, rx) = mpsc::channel();
265263
let pool = ThreadPool {

futures-test/src/task/context.rs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
use crate::task::{noop_waker_ref, panic_waker_ref};
22
use futures_core::task::Context;
33

4-
/// Create a new [`Context`](core::task::Context) where the
5-
/// [waker](core::task::Context::waker) will panic if used.
4+
/// Create a new [`Context`] where the [waker](core::task::Context::waker)
5+
/// will panic if used.
66
///
77
/// # Examples
88
///
@@ -16,8 +16,8 @@ pub fn panic_context() -> Context<'static> {
1616
Context::from_waker(panic_waker_ref())
1717
}
1818

19-
/// Create a new [`Context`](core::task::Context) where the
20-
/// [waker](core::task::Context::waker) will ignore any uses.
19+
/// Create a new [`Context`] where the [waker](core::task::Context::waker)
20+
/// will ignore any uses.
2121
///
2222
/// # Examples
2323
///

futures-test/src/task/noop_spawner.rs

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
use futures_task::{FutureObj, Spawn, SpawnError};
22

3-
/// An implementation of [`Spawn`](futures_task::Spawn) that
4-
/// discards spawned futures when used.
3+
/// An implementation of [`Spawn`] that discards spawned futures when used.
54
///
65
/// # Examples
76
///

futures-test/src/task/panic_spawner.rs

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
use futures_task::{FutureObj, Spawn, SpawnError};
22

3-
/// An implementation of [`Spawn`](futures_task::Spawn) that panics
4-
/// when used.
3+
/// An implementation of [`Spawn`] that panics when used.
54
///
65
/// # Examples
76
///

futures-test/src/task/panic_waker.rs

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,9 @@ const fn raw_panic_waker() -> RawWaker {
2020
RawWaker::new(null(), &PANIC_WAKER_VTABLE)
2121
}
2222

23-
/// Create a new [`Waker`](futures_core::task::Waker) which will
24-
/// panic when `wake()` is called on it. The [`Waker`] can be converted
25-
/// into a [`Waker`] which will behave the same way.
23+
/// Create a new [`Waker`] which will panic when `wake()` is called on it.
24+
/// The [`Waker`] can be converted into a [`Waker`] which will behave the same
25+
/// way.
2626
///
2727
/// # Examples
2828
///
@@ -37,9 +37,8 @@ pub fn panic_waker() -> Waker {
3737
unsafe { Waker::from_raw(raw_panic_waker()) }
3838
}
3939

40-
/// Get a global reference to a
41-
/// [`Waker`](futures_core::task::Waker) referencing a singleton
42-
/// instance of a [`Waker`] which panics when woken.
40+
/// Get a global reference to a [`Waker`] referencing a singleton instance of
41+
/// a [`Waker`] which panics when woken.
4342
///
4443
/// # Examples
4544
///

futures-test/src/task/record_spawner.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
use futures_task::{FutureObj, Spawn, SpawnError};
22
use std::cell::{Ref, RefCell};
33

4-
/// An implementation of [`Spawn`](futures_task::Spawn) that records
5-
/// any [`Future`](futures_core::future::Future)s spawned on it.
4+
/// An implementation of [`Spawn`] that records any
5+
/// [`Future`](futures_core::future::Future)s spawned on it.
66
///
77
/// # Examples
88
///

0 commit comments

Comments
 (0)