From 2d6191a6e79a809bb2b5ac6b1eeb5aba580715e1 Mon Sep 17 00:00:00 2001 From: tottoto Date: Fri, 27 Oct 2023 02:48:22 +0900 Subject: [PATCH] doc(lib): resolve rustdoc warning (#3361) Signed-off-by: Sven Pfennig --- .github/workflows/CI.yml | 2 +- src/body/mod.rs | 4 ++-- src/client/mod.rs | 2 +- src/server/mod.rs | 2 +- src/service/mod.rs | 4 ++-- src/upgrade.rs | 2 +- 6 files changed, 8 insertions(+), 8 deletions(-) diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml index 549aed9144..aae0db6fcf 100644 --- a/.github/workflows/CI.yml +++ b/.github/workflows/CI.yml @@ -227,7 +227,7 @@ jobs: - uses: Swatinem/rust-cache@v2 - name: cargo doc - run: cargo rustdoc --features full,ffi -- --cfg docsrs --cfg hyper_unstable_ffi -D broken-intra-doc-links + run: cargo rustdoc --features full,ffi -- --cfg docsrs --cfg hyper_unstable_ffi -D rustdoc::broken-intra-doc-links check-external-types: name: Check exposed types diff --git a/src/body/mod.rs b/src/body/mod.rs index 4b0f1ed7b1..405c8726d0 100644 --- a/src/body/mod.rs +++ b/src/body/mod.rs @@ -7,10 +7,10 @@ //! //! There are two pieces to this in hyper: //! -//! - **The [`Body`](Body) trait** describes all possible bodies. +//! - **The [`Body`] trait** describes all possible bodies. //! hyper allows any body type that implements `Body`, allowing //! applications to have fine-grained control over their streaming. -//! - **The [`Incoming`](Incoming) concrete type**, which is an implementation +//! - **The [`Incoming`] concrete type**, which is an implementation //! of `Body`, and returned by hyper as a "receive stream" (so, for server //! requests and client responses). //! diff --git a/src/client/mod.rs b/src/client/mod.rs index fcf2bfb74f..4282b53c9c 100644 --- a/src/client/mod.rs +++ b/src/client/mod.rs @@ -1,6 +1,6 @@ //! HTTP Client //! -//! hyper provides HTTP over a single connection. See the [`conn`](conn) module. +//! hyper provides HTTP over a single connection. See the [`conn`] module. //! //! ## Example //! diff --git a/src/server/mod.rs b/src/server/mod.rs index afc704cd98..980553e5e9 100644 --- a/src/server/mod.rs +++ b/src/server/mod.rs @@ -5,5 +5,5 @@ //! //! How exactly you choose to listen for connections is not something hyper //! concerns itself with. After you have a connection, you can handle HTTP over -//! it with the types in the [`conn`](conn) module. +//! it with the types in the [`conn`] module. pub mod conn; diff --git a/src/service/mod.rs b/src/service/mod.rs index a3a3763430..36facc5892 100644 --- a/src/service/mod.rs +++ b/src/service/mod.rs @@ -1,6 +1,6 @@ //! Asynchronous Services //! -//! A [`Service`](Service) is a trait representing an asynchronous +//! A [`Service`] is a trait representing an asynchronous //! function of a request to a response. It's similar to //! `async fn(Request) -> Result`. //! @@ -17,7 +17,7 @@ //! to a single connection. It defines how to respond to **all** requests that //! connection will receive. //! -//! The helper [`service_fn`](service_fn) should be sufficient for most cases, but +//! The helper [`service_fn`] should be sufficient for most cases, but //! if you need to implement `Service` for a type manually, you can follow the example //! in `service_struct_impl.rs`. diff --git a/src/upgrade.rs b/src/upgrade.rs index fb172b8b54..27fe07ac24 100644 --- a/src/upgrade.rs +++ b/src/upgrade.rs @@ -73,7 +73,7 @@ pub struct OnUpgrade { rx: Option>>, } -/// The deconstructed parts of an [`Upgraded`](Upgraded) type. +/// The deconstructed parts of an [`Upgraded`] type. /// /// Includes the original IO type, and a read buffer of bytes that the /// HTTP state machine may have already read before completing an upgrade.