Update docs

Author: yoshuawuyts

src/content/accept.rs

@@ -1,4 +1,4 @@
-//! Client header advertising available compression algorithms.
+//! Client header advertising which media types the client is able to understand
 
 use crate::content::{ContentType, MediaTypeProposal};
 use crate::headers::{HeaderName, HeaderValue, Headers, ToHeaderValues, ACCEPT};
@@ -9,11 +9,19 @@ use std::fmt::{self, Debug, Write};
 use std::option;
 use std::slice;
 
-/// Client header advertising available compression algorithms.
+/// Client header advertising which media types the client is able to understand
+///
+/// Using content negotiation, the server then selects one of the proposals, uses
+/// it and informs the client of its choice with the `Content-Type` response
+/// header. Browsers set adequate values for this header depending on the context
+/// where the request is done: when fetching a CSS stylesheet a different value
+/// is set for the request than when fetching an image, video or a script.
+///
+/// [MDN Documentation](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Encoding)
 ///
 /// # Specifications
 ///
-/// - [RFC 7231, section 5.3.4: Accept-Encoding](https://tools.ietf.org/html/rfc7231#section-5.3.4)
+/// - [RFC 7231, section 5.3.2: Accept](https://tools.ietf.org/html/rfc7231#section-5.3.2)
 ///
 /// # Examples
 ///

src/content/mod.rs

@@ -4,6 +4,28 @@
 //! about which content it prefers, and the server responds by sharing which
 //! content it's chosen to share. This enables clients to receive resources with the
 //! best available compression, in the preferred language, and more.
+//!
+//! # Examples
+//!
+//! ```
+//! # fn main() -> http_types::Result<()> {
+//! #
+//! use http_types::content::{Accept, MediaTypeProposal};
+//! use http_types::{mime, Response};
+//!
+//! let mut accept = Accept::new();
+//! accept.push(MediaTypeProposal::new(mime::HTML, Some(0.8))?);
+//! accept.push(MediaTypeProposal::new(mime::XML, Some(0.4))?);
+//! accept.push(MediaTypeProposal::new(mime::PLAIN, None)?);
+//!
+//! let mut res = Response::new(200);
+//! let content_type = accept.negotiate(&[mime::XML])?;
+//! content_type.apply(&mut res);
+//!
+//! assert_eq!(res["Content-Type"], "application/xml;charset=utf-8");
+//! #
+//! # Ok(()) }
+//! ```
 
 pub mod accept;
 pub mod accept_encoding;
@@ -16,6 +38,7 @@ mod encoding;
 mod encoding_proposal;
 mod media_type_proposal;
 
+#[doc(inline)]
 pub use accept::Accept;
 #[doc(inline)]
 pub use accept_encoding::AcceptEncoding;