From 299a1c2448e838978de07114971cad4cae50ba16 Mon Sep 17 00:00:00 2001 From: Alex Rudy Date: Thu, 5 Sep 2024 19:13:06 +0000 Subject: [PATCH] chore: fix docstrings so clippy in rust-1.82 is happy --- src/service/client.rs | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/src/service/client.rs b/src/service/client.rs index 669c1e7..33138b4 100644 --- a/src/service/client.rs +++ b/src/service/client.rs @@ -16,11 +16,12 @@ use crate::client::pool::PoolableConnection; use crate::client::pool::Pooled; use crate::client::Error; -/// Couples the connection with the http request, so that downstream -/// services can access both - they are needed in tandem to send -/// the request. This also means that middleware can implement -/// [`tower::Service`] on `tower::Service>` to -/// modify the request before it is sent in the context of the connection. +/// Couples the connection with the http request. +/// +/// This allows downstream services to access both the request and connection +/// -- they are needed in tandem to send the request. This also means that +/// middleware can implement [`tower::Service`] on `tower::Service>` +/// to modify the request before it is sent in the context of the connection. /// /// See [`crate::service::SetHostHeader`] for an example of a middleware that modifies /// the request before it is sent in the context of the connection. @@ -59,6 +60,8 @@ impl + PoolableConnection, B> ExecuteRequest { } } +/// A service to execute a request on a hyper connection. +/// /// A service which executes a request on a `hyper` Connection as described /// by the `Connection` trait. This should be the innermost service /// for clients, as it is responsible for actually sending the request.