From b0db515bdda66a8730780f3b5f65f4366f2067dd Mon Sep 17 00:00:00 2001 From: Sean McArthur Date: Fri, 10 Aug 2018 14:27:45 -0700 Subject: [PATCH] fix some autolinks that weren't resolving in docs (#305) --- src/client.rs | 19 ++++++++----------- src/share.rs | 2 +- 2 files changed, 9 insertions(+), 12 deletions(-) diff --git a/src/client.rs b/src/client.rs index a94f26f..bfd13ff 100644 --- a/src/client.rs +++ b/src/client.rs @@ -425,6 +425,7 @@ where /// /// See [module] level docs for more details. /// + /// [`poll_ready`]: #method.poll_ready /// [module]: index.html pub fn ready(self) -> ReadySendRequest { ReadySendRequest { inner: Some(self) } @@ -930,11 +931,9 @@ impl Builder { /// Sets the maximum number of concurrent locally reset streams. /// - /// When a stream is explicitly reset by either calling - /// [`SendResponse::send_reset`] or by dropping a [`SendResponse`] instance - /// before completing the stream, the HTTP/2.0 specification requires that - /// any further frames received for that stream must be ignored for "some - /// time". + /// When a stream is explicitly reset, the HTTP/2.0 specification requires + /// that any further frames received for that stream must be ignored for + /// "some time". /// /// In order to satisfy the specification, internal state must be maintained /// to implement the behavior. This state grows linearly with the number of @@ -976,13 +975,11 @@ impl Builder { self } - /// Sets the maximum number of concurrent locally reset streams. + /// Sets the duration to remember locally reset streams. /// - /// When a stream is explicitly reset by either calling - /// [`SendResponse::send_reset`] or by dropping a [`SendResponse`] instance - /// before completing the stream, the HTTP/2.0 specification requires that - /// any further frames received for that stream must be ignored for "some - /// time". + /// When a stream is explicitly reset, the HTTP/2.0 specification requires + /// that any further frames received for that stream must be ignored for + /// "some time". /// /// In order to satisfy the specification, internal state must be maintained /// to implement the behavior. This state grows linearly with the number of diff --git a/src/share.rs b/src/share.rs index d98a592..a42d5e1 100644 --- a/src/share.rs +++ b/src/share.rs @@ -277,7 +277,7 @@ impl SendStream { /// Requests to be notified when the stream's capacity increases. /// /// Before calling this, capacity should be requested with - /// [`reserve_capacity`]. Once capacity is requested, the connection will + /// `reserve_capacity`. Once capacity is requested, the connection will /// assign capacity to the stream **as it becomes available**. There is no /// guarantee as to when and in what increments capacity gets assigned to /// the stream.