docs(*): fix typos, Markdown inconsistencies, and stutter
This commit is contained in:
		| @@ -5,9 +5,8 @@ use header::parsing::{from_comma_delimited, fmt_comma_delimited}; | |||||||
|  |  | ||||||
| /// `Prefer` header, defined in [RFC7240](http://tools.ietf.org/html/rfc7240) | /// `Prefer` header, defined in [RFC7240](http://tools.ietf.org/html/rfc7240) | ||||||
| /// | /// | ||||||
| /// The `Prefer` header field is HTTP header field that can be used by a | /// The `Prefer` header field can be used by a client to request that certain | ||||||
| /// client to request that certain behaviors be employed by a server | /// behaviors be employed by a server while processing a request. | ||||||
| /// while processing a request. |  | ||||||
| /// | /// | ||||||
| /// # ABNF | /// # ABNF | ||||||
| /// ```plain | /// ```plain | ||||||
|   | |||||||
| @@ -73,7 +73,7 @@ impl Method { | |||||||
|     } |     } | ||||||
|  |  | ||||||
|     /// Whether a method is considered "idempotent", meaning the request has |     /// Whether a method is considered "idempotent", meaning the request has | ||||||
|     /// the same result is executed multiple times. |     /// the same result if executed multiple times. | ||||||
|     /// |     /// | ||||||
|     /// See [the spec](https://tools.ietf.org/html/rfc7231#section-4.2.2) for |     /// See [the spec](https://tools.ietf.org/html/rfc7231#section-4.2.2) for | ||||||
|     /// more words. |     /// more words. | ||||||
|   | |||||||
| @@ -179,7 +179,7 @@ pub trait Ssl { | |||||||
|     fn wrap_server(&self, stream: HttpStream) -> ::Result<Self::Stream>; |     fn wrap_server(&self, stream: HttpStream) -> ::Result<Self::Stream>; | ||||||
| } | } | ||||||
|  |  | ||||||
| /// An abstraction to allow any SSL implementation to be used with client-side HttpsStreams. | /// An abstraction to allow any SSL implementation to be used with client-side `HttpsStream`s. | ||||||
| pub trait SslClient { | pub trait SslClient { | ||||||
|     /// The protected stream. |     /// The protected stream. | ||||||
|     type Stream: Transport; |     type Stream: Transport; | ||||||
| @@ -187,7 +187,7 @@ pub trait SslClient { | |||||||
|     fn wrap_client(&self, stream: HttpStream, host: &str) -> ::Result<Self::Stream>; |     fn wrap_client(&self, stream: HttpStream, host: &str) -> ::Result<Self::Stream>; | ||||||
| } | } | ||||||
|  |  | ||||||
| /// An abstraction to allow any SSL implementation to be used with server-side HttpsStreams. | /// An abstraction to allow any SSL implementation to be used with server-side `HttpsStream`s. | ||||||
| pub trait SslServer { | pub trait SslServer { | ||||||
|     /// The protected stream. |     /// The protected stream. | ||||||
|     type Stream: Transport; |     type Stream: Transport; | ||||||
| @@ -323,7 +323,7 @@ impl<S: Transport> Transport for HttpsStream<S> { | |||||||
|     } |     } | ||||||
| } | } | ||||||
|  |  | ||||||
| /// A Http Listener over SSL. | /// An `HttpListener` over SSL. | ||||||
| #[derive(Debug)] | #[derive(Debug)] | ||||||
| pub struct HttpsListener<S: SslServer> { | pub struct HttpsListener<S: SslServer> { | ||||||
|     listener: TcpListener, |     listener: TcpListener, | ||||||
| @@ -340,7 +340,7 @@ impl<S: SslServer> HttpsListener<S> { | |||||||
|         }) |         }) | ||||||
|     } |     } | ||||||
|  |  | ||||||
|     /// Construct an HttpsListener from a bound `TcpListener`. |     /// Construct an `HttpsListener` from a bound `TcpListener`. | ||||||
|     pub fn with_listener(listener: TcpListener, ssl: S) -> HttpsListener<S> { |     pub fn with_listener(listener: TcpListener, ssl: S) -> HttpsListener<S> { | ||||||
|         HttpsListener { |         HttpsListener { | ||||||
|             listener: listener, |             listener: listener, | ||||||
|   | |||||||
| @@ -1,6 +1,6 @@ | |||||||
| //! HTTP Server | //! HTTP Server | ||||||
| //! | //! | ||||||
| //! A `Server` is created to listen on port, parse HTTP requests, and hand | //! A `Server` is created to listen on a port, parse HTTP requests, and hand | ||||||
| //! them off to a `Handler`. | //! them off to a `Handler`. | ||||||
| use std::fmt; | use std::fmt; | ||||||
| use std::net::SocketAddr; | use std::net::SocketAddr; | ||||||
|   | |||||||
		Reference in New Issue
	
	Block a user