diff options
| author | Nikita Baksalyar <nikita.baksalyar@gmail.com> | 2020-04-12 14:59:37 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-04-12 15:59:37 +0200 |
| commit | 8118f8f117a5b544f3bc6b3ce4e639a2a605afcb (patch) | |
| tree | c6002b471079d5f867b5b8916b77ffbf26790b76 /tokio | |
| parent | 1e679748ecedfb0e894c5028eb8c67f44e47507a (diff) | |
docs: fix incorrect documentation links & formatting (#2332)
The streams documentation referred to module-level 'split' doc which is no longer there
Diffstat (limited to 'tokio')
| -rw-r--r-- | tokio/src/net/tcp/stream.rs | 3 | ||||
| -rw-r--r-- | tokio/src/net/udp/socket.rs | 3 | ||||
| -rw-r--r-- | tokio/src/net/unix/stream.rs | 3 | ||||
| -rw-r--r-- | tokio/src/sync/mpsc/error.rs | 2 |
4 files changed, 1 insertions, 10 deletions
diff --git a/tokio/src/net/tcp/stream.rs b/tokio/src/net/tcp/stream.rs index f9c2e98f..6df35a40 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 604da98b..faf1dca6 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 1ce9c863..beae6999 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 99193563..72c42aa5 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(()); |