-
-
Notifications
You must be signed in to change notification settings - Fork 1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Fix small typos in Client
docs
#1253
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -53,7 +53,7 @@ use crate::{IntoUrl, Method, Proxy, StatusCode, Url}; | |
/// The `Client` holds a connection pool internally, so it is advised that | ||
/// you create one and **reuse** it. | ||
/// | ||
/// You do **not** have to wrap the `Client` it in an [`Rc`] or [`Arc`] to **reuse** it, | ||
/// You do **not** have to wrap the `Client` in an [`Rc`] or [`Arc`] to **reuse** it, | ||
/// because it already uses an [`Arc`] internally. | ||
/// | ||
/// [`Rc`]: std::rc::Rc | ||
|
@@ -62,7 +62,7 @@ pub struct Client { | |
inner: Arc<ClientRef>, | ||
} | ||
|
||
/// A `ClientBuilder` can be used to create a `Client` with custom configuration. | ||
/// A `ClientBuilder` can be used to create a `Client` with custom configuration. | ||
#[must_use] | ||
pub struct ClientBuilder { | ||
config: Config, | ||
|
@@ -172,7 +172,7 @@ impl ClientBuilder { | |
/// | ||
/// # Errors | ||
/// | ||
/// This method fails if TLS backend cannot be initialized, or the resolver | ||
/// This method fails if a TLS backend cannot be initialized, or the resolver | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Could also be "the" 🤷 |
||
/// cannot load the system configuration. | ||
pub fn build(self) -> crate::Result<Client> { | ||
let config = self.config; | ||
|
@@ -497,8 +497,8 @@ impl ClientBuilder { | |
/// - When sending a request and if the request's headers do not already contain | ||
/// an `Accept-Encoding` **and** `Range` values, the `Accept-Encoding` header is set to `gzip`. | ||
/// The request body is **not** automatically compressed. | ||
/// - When receiving a response, if it's headers contain a `Content-Encoding` value that | ||
/// equals to `gzip`, both values `Content-Encoding` and `Content-Length` are removed from the | ||
/// - When receiving a response, if its headers contain a `Content-Encoding` value of | ||
/// `gzip`, both `Content-Encoding` and `Content-Length` are removed from the | ||
/// headers' set. The response body is automatically decompressed. | ||
/// | ||
/// If the `gzip` feature is turned on, the default option is enabled. | ||
|
@@ -520,8 +520,8 @@ impl ClientBuilder { | |
/// - When sending a request and if the request's headers do not already contain | ||
/// an `Accept-Encoding` **and** `Range` values, the `Accept-Encoding` header is set to `br`. | ||
/// The request body is **not** automatically compressed. | ||
/// - When receiving a response, if it's headers contain a `Content-Encoding` value that | ||
/// equals to `br`, both values `Content-Encoding` and `Content-Length` are removed from the | ||
/// - When receiving a response, if its headers contain a `Content-Encoding` value of | ||
/// `br`, both `Content-Encoding` and `Content-Length` are removed from the | ||
/// headers' set. The response body is automatically decompressed. | ||
/// | ||
/// If the `brotli` feature is turned on, the default option is enabled. | ||
|
@@ -1003,7 +1003,7 @@ impl Client { | |
/// | ||
/// # Panics | ||
/// | ||
/// This method panics if TLS backend cannot initialized, or the resolver | ||
/// This method panics if a TLS backend cannot initialized, or the resolver | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Ditto - could also be "the" 🤷 |
||
/// cannot load the system configuration. | ||
/// | ||
/// Use `Client::builder()` if you wish to handle the failure as an `Error` | ||
|
@@ -1023,7 +1023,7 @@ impl Client { | |
/// | ||
/// # Errors | ||
/// | ||
/// This method fails whenever supplied `Url` cannot be parsed. | ||
/// This method fails whenever the supplied `Url` cannot be parsed. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I also kind of want to change |
||
pub fn get<U: IntoUrl>(&self, url: U) -> RequestBuilder { | ||
self.request(Method::GET, url) | ||
} | ||
|
@@ -1032,7 +1032,7 @@ impl Client { | |
/// | ||
/// # Errors | ||
/// | ||
/// This method fails whenever supplied `Url` cannot be parsed. | ||
/// This method fails whenever the supplied `Url` cannot be parsed. | ||
pub fn post<U: IntoUrl>(&self, url: U) -> RequestBuilder { | ||
self.request(Method::POST, url) | ||
} | ||
|
@@ -1041,7 +1041,7 @@ impl Client { | |
/// | ||
/// # Errors | ||
/// | ||
/// This method fails whenever supplied `Url` cannot be parsed. | ||
/// This method fails whenever the supplied `Url` cannot be parsed. | ||
pub fn put<U: IntoUrl>(&self, url: U) -> RequestBuilder { | ||
self.request(Method::PUT, url) | ||
} | ||
|
@@ -1050,7 +1050,7 @@ impl Client { | |
/// | ||
/// # Errors | ||
/// | ||
/// This method fails whenever supplied `Url` cannot be parsed. | ||
/// This method fails whenever the supplied `Url` cannot be parsed. | ||
pub fn patch<U: IntoUrl>(&self, url: U) -> RequestBuilder { | ||
self.request(Method::PATCH, url) | ||
} | ||
|
@@ -1059,7 +1059,7 @@ impl Client { | |
/// | ||
/// # Errors | ||
/// | ||
/// This method fails whenever supplied `Url` cannot be parsed. | ||
/// This method fails whenever the supplied `Url` cannot be parsed. | ||
pub fn delete<U: IntoUrl>(&self, url: U) -> RequestBuilder { | ||
self.request(Method::DELETE, url) | ||
} | ||
|
@@ -1068,19 +1068,19 @@ impl Client { | |
/// | ||
/// # Errors | ||
/// | ||
/// This method fails whenever supplied `Url` cannot be parsed. | ||
/// This method fails whenever the supplied `Url` cannot be parsed. | ||
pub fn head<U: IntoUrl>(&self, url: U) -> RequestBuilder { | ||
self.request(Method::HEAD, url) | ||
} | ||
|
||
/// Start building a `Request` with the `Method` and `Url`. | ||
/// | ||
/// Returns a `RequestBuilder`, which will allow setting headers and | ||
/// request body before sending. | ||
/// the request body before sending. | ||
/// | ||
/// # Errors | ||
/// | ||
/// This method fails whenever supplied `Url` cannot be parsed. | ||
/// This method fails whenever the supplied `Url` cannot be parsed. | ||
pub fn request<U: IntoUrl>(&self, method: Method, url: U) -> RequestBuilder { | ||
let req = url.into_url().map(move |url| Request::new(method, url)); | ||
RequestBuilder::new(self.clone(), req) | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm also not sure if we need this anymore since [
Rc
] will automatically link to the docs on newer Rust versions. I see we didn't have an explicit link for [Arc
] so I wasn't totally sure what to do here.