Skip to content

Commit 0fc0a94

Browse files
authored
docs: fix broken intradoc links (#162)
address warnings like the following, when docs are built using the current stable release: ``` Documenting http-body-util v0.1.3 (/http-body/http-body/http-body-util) error: unresolved link to `Poll::Ready(None)` --> http-body-util/src/combinators/fuse.rs:10:28 | 10 | /// This [`Body`] yields [`Poll::Ready(None)`] forever after the underlying body yields | ^^^^^^^^^^^^^^^^^ the enum `Poll` has no variant or associated item named `Ready(None)` | = note: requested on the command line with `-D rustdoc::broken-intra-doc-links` error: unresolved link to `Poll::Ready(Some(Ok(frame)))` --> http-body/src/lib.rs:53:13 | 53 | /// - [`Poll::Ready(Some(Ok(frame)))`] when the next frame is available. | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ the enum `Poll` has no variant or associated item named `Ready(Some(Ok(frame)))` | = note: requested on the command line with `-D rustdoc::broken-intra-doc-links` ``` Signed-off-by: katelyn martin <[email protected]>
1 parent 5a849d4 commit 0fc0a94

File tree

3 files changed

+11
-11
lines changed

3 files changed

+11
-11
lines changed

http-body-util/src/combinators/fuse.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,10 @@ use http_body::{Body, Frame, SizeHint};
77

88
/// A "fused" [`Body`].
99
///
10-
/// This [`Body`] yields [`Poll::Ready(None)`] forever after the underlying body yields
11-
/// [`Poll::Ready(None)`], or an error [`Poll::Ready(Some(Err(_)))`], once.
10+
/// This [`Body`] yields `Poll::Ready(None)` forever after the underlying body yields
11+
/// `Poll::Ready(None)`, or an error `Poll::Ready(Some(Err(_)))`, once.
1212
///
13-
/// Bodies should ideally continue to return [`Poll::Ready(None)`] indefinitely after the end of
13+
/// Bodies should ideally continue to return `Poll::Ready(None)` indefinitely after the end of
1414
/// the stream is reached. [`Fuse<B>`] avoids polling its underlying body `B` further after the
1515
/// underlying stream as ended, which can be useful for implementation that cannot uphold this
1616
/// guarantee.

http-body-util/src/lib.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -154,8 +154,8 @@ pub trait BodyExt: http_body::Body {
154154

155155
/// Creates a "fused" body.
156156
///
157-
/// This [`Body`][http_body::Body] yields [`Poll::Ready(None)`] forever after the underlying
158-
/// body yields [`Poll::Ready(None)`], or an error [`Poll::Ready(Some(Err(_)))`], once.
157+
/// This [`Body`][http_body::Body] yields `Poll::Ready(None)` forever after the underlying
158+
/// body yields `Poll::Ready(None)`, or an error `Poll::Ready(Some(Err(_)))`, once.
159159
///
160160
/// See [`Fuse<B>`][combinators::Fuse] for more information.
161161
fn fuse(self) -> combinators::Fuse<Self>

http-body/src/lib.rs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -49,16 +49,16 @@ pub trait Body {
4949
///
5050
/// This function returns:
5151
///
52-
/// - [`Poll::Pending`] if the next frame is not ready yet.
53-
/// - [`Poll::Ready(Some(Ok(frame)))`] when the next frame is available.
54-
/// - [`Poll::Ready(Some(Err(error)))`] when an error has been reached.
55-
/// - [`Poll::Ready(None)`] means that all of the frames in this stream have been returned, and
52+
/// - `Poll::Pending` if the next frame is not ready yet.
53+
/// - `Poll::Ready(Some(Ok(frame)))` when the next frame is available.
54+
/// - `Poll::Ready(Some(Err(error)))` when an error has been reached.
55+
/// - `Poll::Ready(None)` means that all of the frames in this stream have been returned, and
5656
/// that the end of the stream has been reached.
5757
///
58-
/// If [`Poll::Ready(Some(Err(error)))`] is returned, this body should be discarded.
58+
/// If `Poll::Ready(Some(Err(error)))` is returned, this body should be discarded.
5959
///
6060
/// Once the end of the stream is reached, implementations should continue to return
61-
/// [`Poll::Ready(None)`].
61+
/// `Poll::Ready(None)`.
6262
fn poll_frame(
6363
self: Pin<&mut Self>,
6464
cx: &mut Context<'_>,

0 commit comments

Comments
 (0)