Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: fix a few broken links by using rustdoc #2400

Merged
merged 7 commits into from Apr 13, 2020
Merged

doc: fix a few broken links by using rustdoc #2400

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
fd3d804
doc: unlink `driver` in `tokio::runtime`
Apr 12, 2020
d502591
doc: fix link for TcpStream
Apr 13, 2020
1262fa4
doc: fix Runtime::block_on method
Apr 13, 2020
1554330
doc: fix link for spawn_blocking
Apr 13, 2020
3f46ba7
doc: fix link for in_place
Apr 13, 2020
e19a0d4
doc: Remove Timer reference from DelayQueue's docs
Apr 13, 2020
5cce988
Merge branch 'master' into 1473-fix-links
Apr 13, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion tokio/src/net/tcp/listener.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ impl TcpListener {
/// established, the corresponding [`TcpStream`] and the remote peer's
/// address will be returned.
///
/// [`TcpStream`]: ../struct.TcpStream.html
/// [`TcpStream`]: struct@crate::net::TcpStream
///
/// # Examples
///
Expand Down
3 changes: 1 addition & 2 deletions tokio/src/runtime/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -245,7 +245,7 @@ use std::time::Duration;

/// The Tokio runtime.
///
/// The runtime provides an I/O [driver], task scheduler, [timer], and blocking
/// The runtime provides an I/O driver, task scheduler, [timer], and blocking
/// pool, necessary for running asynchronous tasks.
///
/// Instances of `Runtime` can be created using [`new`] or [`Builder`]. However,
Expand All @@ -266,7 +266,6 @@ use std::time::Duration;
/// that reactor will no longer function. Calling any method on them will
/// result in an error.
///
/// [driver]: crate::io::driver
/// [timer]: crate::time
/// [mod]: index.html
/// [`new`]: #method.new
Expand Down
6 changes: 3 additions & 3 deletions tokio/src/task/local.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ cfg_rt_util! {
///
/// [`Send`]: https://doc.rust-lang.org/std/marker/trait.Send.html
/// [local task set]: struct@LocalSet
/// [`Runtime::block_on`]: ../struct.Runtime.html#method.block_on
/// [`Runtime::block_on`]: method@crate::runtime::Runtime::block_on
/// [`task::spawn_local`]: fn@spawn_local
pub struct LocalSet {
/// Current scheduler tick
Expand Down Expand Up @@ -336,9 +336,9 @@ impl LocalSet {
/// ```
///
/// [`spawn_local`]: fn@spawn_local
/// [`Runtime::block_on`]: ../struct.Runtime.html#method.block_on
/// [`Runtime::block_on`]: method@crate::runtime::Runtime::block_on
/// [in-place blocking]: ../blocking/fn.in_place.html
/// [`spawn_blocking`]: ../blocking/fn.spawn_blocking.html
/// [`spawn_blocking`]: fn@crate::task::spawn_blocking
pub fn block_on<F>(&self, rt: &mut crate::runtime::Runtime, future: F) -> F::Output
where
F: Future,
Expand Down