Skip to content

Commit

Permalink
Fix intra_doc_link_resolution_failure warnings
Browse files Browse the repository at this point in the history
  • Loading branch information
taiki-e committed Nov 3, 2019
1 parent c14c054 commit c9a1b51
Show file tree
Hide file tree
Showing 8 changed files with 13 additions and 14 deletions.
6 changes: 3 additions & 3 deletions futures-executor/src/local_pool.rs
Original file line number Diff line number Diff line change
Expand Up @@ -20,18 +20,18 @@ use std::thread::{self, Thread};
/// little work in between I/O actions.
///
/// To get a handle to the pool that implements
/// [`Spawn`](futures_core::task::Spawn), use the
/// [`Spawn`](futures_task::Spawn), use the
/// [`spawner()`](LocalPool::spawner) method. Because the executor is
/// single-threaded, it supports a special form of task spawning for non-`Send`
/// futures, via [`spawn_local_obj`](futures_core::task::LocalSpawn::spawn_local_obj).
/// futures, via [`spawn_local_obj`](futures_task::LocalSpawn::spawn_local_obj).
#[derive(Debug)]
pub struct LocalPool {
pool: FuturesUnordered<LocalFutureObj<'static, ()>>,
incoming: Rc<Incoming>,
}

/// A handle to a [`LocalPool`](LocalPool) that implements
/// [`Spawn`](futures_core::task::Spawn).
/// [`Spawn`](futures_task::Spawn).
#[derive(Clone, Debug)]
pub struct LocalSpawner {
incoming: Weak<Incoming>,
Expand Down
6 changes: 3 additions & 3 deletions futures-task/src/arc_wake.rs
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,12 @@ use alloc::sync::Arc;
///
/// Currently, there are two ways to convert `ArcWake` into [`Waker`]:
///
/// * [`waker`](crate::task::waker()) converts `Arc<impl ArcWake>` into [`Waker`].
/// * [`waker_ref`](crate::task::waker_ref()) converts `&Arc<impl ArcWake>` into [`WakerRef`] that
/// * [`waker`](super::waker()) converts `Arc<impl ArcWake>` into [`Waker`].
/// * [`waker_ref`](super::waker_ref()) converts `&Arc<impl ArcWake>` into [`WakerRef`] that
/// provides access to a [`&Waker`][`Waker`].
///
/// [`Waker`]: std::task::Waker
/// [`WakerRef`]: crate::task::WakerRef
/// [`WakerRef`]: super::WakerRef
// Note: Send + Sync required because `Arc<T>` doesn't automatically imply
// those bounds, but `Waker` implements them.
pub trait ArcWake: Send + Sync {
Expand Down
3 changes: 1 addition & 2 deletions futures-task/src/future_obj.rs
Original file line number Diff line number Diff line change
Expand Up @@ -104,8 +104,7 @@ impl<T> Drop for LocalFutureObj<'_, T> {
/// contexts.
///
/// You should generally not need to use this type outside of `no_std` or when
/// implementing `Spawn`, consider using [`BoxFuture`](crate::future::BoxFuture)
/// instead.
/// implementing `Spawn`, consider using `BoxFuture` instead.
pub struct FutureObj<'a, T>(LocalFutureObj<'a, T>);

impl<T> Unpin for FutureObj<'_, T> {}
Expand Down
2 changes: 1 addition & 1 deletion futures-test/src/task/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
//! This module provides utilities for creating test
//! [`Context`](futures_core::task::Context)s,
//! [`Waker`](futures_core::task::Waker)s and
//! [`Spawn`](futures_core::task::Spawn) implementations.
//! [`Spawn`](futures_task::Spawn) implementations.
//!
//! Test contexts:
//! - [`noop_context`](crate::task::noop_context) creates a context that ignores calls to
Expand Down
2 changes: 1 addition & 1 deletion futures-test/src/task/noop_spawner.rs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
use futures_task::{Spawn, SpawnError, FutureObj};

/// An implementation of [`Spawn`](futures_core::task::Spawn) that
/// An implementation of [`Spawn`](futures_task::Spawn) that
/// discards spawned futures when used.
///
/// # Examples
Expand Down
2 changes: 1 addition & 1 deletion futures-test/src/task/panic_spawner.rs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
use futures_task::{Spawn, SpawnError, FutureObj};

/// An implementation of [`Spawn`](futures_core::task::Spawn) that panics
/// An implementation of [`Spawn`](futures_task::Spawn) that panics
/// when used.
///
/// # Examples
Expand Down
2 changes: 1 addition & 1 deletion futures-test/src/task/record_spawner.rs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
use futures_task::{Spawn, SpawnError, FutureObj};

/// An implementation of [`Spawn`](futures_core::task::Spawn) that records
/// An implementation of [`Spawn`](futures_task::Spawn) that records
/// any [`Future`](futures_core::future::Future)s spawned on it.
///
/// # Examples
Expand Down
4 changes: 2 additions & 2 deletions futures-util/src/compat/executor.rs
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ pub trait Executor01CompatExt: Executor01<Executor01Future> +
Clone + Send + 'static
{
/// Converts a futures 0.1 [`Executor`](futures_01::future::Executor) into a
/// futures 0.3 [`Spawn`](futures_core::task::Spawn).
/// futures 0.3 [`Spawn`](futures_task::Spawn).
///
/// ```
/// use futures::task::SpawnExt;
Expand Down Expand Up @@ -56,7 +56,7 @@ where Ex: Executor01<Executor01Future> + Clone + Send + 'static
}

/// Converts a futures 0.1 [`Executor`](futures_01::future::Executor) into a
/// futures 0.3 [`Spawn`](futures_core::task::Spawn).
/// futures 0.3 [`Spawn`](futures_task::Spawn).
#[derive(Debug, Clone)]
pub struct Executor01As03<Ex> {
executor01: Ex
Expand Down

0 comments on commit c9a1b51

Please sign in to comment.