updating comments

Author: ParkMyCar

src/common/accept_encoding.rs

@@ -31,19 +31,19 @@ derive_header! {
 }
 
 impl AcceptEncoding {
-    /// Convience method
+    /// Convience method to create an `Accept-Encoding: gzip` header
     #[inline]
     pub fn gzip() -> AcceptEncoding {
         AcceptEncoding(HeaderValue::from_static("gzip").into())
     }
 
     /// A convience method to create an Accept-Encoding header from pairs of values and qualities
-    /// 
-    /// # Example 
-    /// 
+    ///
+    /// # Example
+    ///
     /// ```
     /// use headers::AcceptEncoding;
-    /// 
+    ///
     /// let pairs = vec![("gzip", 1.0), ("deflate", 0.8)];
     /// let header = AcceptEncoding::from_quality_pairs(&mut pairs.into_iter());
     /// ```
@@ -60,7 +60,7 @@ impl AcceptEncoding {
         Ok(AcceptEncoding(value))
     }
 
-    /// Returns the most prefered encoding that is specified by the client,
+    /// Returns the most prefered encoding that is specified by the header,
     /// if one is specified.
     ///
     /// Note: This peeks at the underlying iter, not modifying it.

src/util/quality_value.rs

@@ -6,6 +6,17 @@ use itertools::Itertools;
 use util::{FlatCsv, TryFromValues};
 use HeaderValue;
 
+/// A CSV list that respects the Quality Values syntax defined in
+/// [RFC7321](https://tools.ietf.org/html/rfc7231#section-5.3.1)
+/// 
+/// Many of the request header fields for proactive negotiation use a
+/// common parameter, named "q" (case-insensitive), to assign a relative
+/// "weight" to the preference for that associated kind of content.  This
+/// weight is referred to as a "quality value" (or "qvalue") because the
+/// same parameter name is often used within server configurations to
+/// assign a weight to the relative quality of the various
+/// representations that can be selected for a resource.
+/// 
 #[derive(Clone, Debug, PartialEq, Eq, Hash)]
 pub(crate) struct QualityValue<QualSep = SemiQ> {
     csv: FlatCsv,