From 8118f8f117a5b544f3bc6b3ce4e639a2a605afcb Mon Sep 17 00:00:00 2001 From: Nikita Baksalyar Date: Sun, 12 Apr 2020 14:59:37 +0100 Subject: [PATCH] docs: fix incorrect documentation links & formatting (#2332) The streams documentation referred to module-level 'split' doc which is no longer there --- tokio/src/net/tcp/stream.rs | 3 --- tokio/src/net/udp/socket.rs | 3 --- tokio/src/net/unix/stream.rs | 3 --- tokio/src/sync/mpsc/error.rs | 2 +- 4 files changed, 1 insertion(+), 10 deletions(-) diff --git a/tokio/src/net/tcp/stream.rs b/tokio/src/net/tcp/stream.rs index f9c2e98fb..6df35a40b 100644 --- a/tokio/src/net/tcp/stream.rs +++ b/tokio/src/net/tcp/stream.rs @@ -614,9 +614,6 @@ impl TcpStream { /// Splits a `TcpStream` into a read half and a write half, which can be used /// to read and write the stream concurrently. - /// - /// See the module level documenation of [`split`](super::split) for more - /// details. pub fn split(&mut self) -> (ReadHalf<'_>, WriteHalf<'_>) { split(self) } diff --git a/tokio/src/net/udp/socket.rs b/tokio/src/net/udp/socket.rs index 604da98bd..faf1dca61 100644 --- a/tokio/src/net/udp/socket.rs +++ b/tokio/src/net/udp/socket.rs @@ -74,9 +74,6 @@ impl UdpSocket { /// Splits the `UdpSocket` into a receive half and a send half. The two parts /// can be used to receive and send datagrams concurrently, even from two /// different tasks. - /// - /// See the module level documenation of [`split`](super::split) for more - /// details. pub fn split(self) -> (RecvHalf, SendHalf) { split(self) } diff --git a/tokio/src/net/unix/stream.rs b/tokio/src/net/unix/stream.rs index 1ce9c863f..beae69996 100644 --- a/tokio/src/net/unix/stream.rs +++ b/tokio/src/net/unix/stream.rs @@ -111,9 +111,6 @@ impl UnixStream { /// Split a `UnixStream` into a read half and a write half, which can be used /// to read and write the stream concurrently. - /// - /// See the module level documenation of [`split`](super::split) for more - /// details. pub fn split(&mut self) -> (ReadHalf<'_>, WriteHalf<'_>) { split(self) } diff --git a/tokio/src/sync/mpsc/error.rs b/tokio/src/sync/mpsc/error.rs index 991935631..72c42aa53 100644 --- a/tokio/src/sync/mpsc/error.rs +++ b/tokio/src/sync/mpsc/error.rs @@ -96,7 +96,7 @@ impl Error for TryRecvError {} // ===== ClosedError ===== -/// Error returned by [`Sender::poll_ready`](super::Sender::poll_ready)]. +/// Error returned by [`Sender::poll_ready`](super::Sender::poll_ready). #[derive(Debug)] pub struct ClosedError(());