Fix small typos in Client docs
#1253
Conversation
| @@ -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 | |||
There was a problem hiding this comment.
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.
| @@ -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.
Could also be "the" 🤷
| @@ -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.
Ditto - could also be "the" 🤷
| @@ -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.
I also kind of want to change Url to url or something because, if someone passes an honest-to-goodness Url, I'm guess it can't not be parsed. The issue is if they pass a non-Url url I assume? But that's pretty pedantic (and also maybe wrong).
|
Done acd31d9 |
Just some typos I noticed while reading the docs. Happy to not change any of them!