From 90b4f2a375fb492e04b382f09db99f5c655f7e45 Mon Sep 17 00:00:00 2001
From: Rob Ede <robjtede@icloud.com>
Date: Sun, 5 Dec 2021 03:08:53 +0000
Subject: [PATCH] improve docs

---
 actix-http/src/header/mod.rs                 |  7 ++++---
 actix-http/src/header/shared/quality.rs      |  2 +-
 actix-http/src/header/shared/quality_item.rs |  2 +-
 actix-http/src/header/utils.rs               |  5 +++--
 actix-multipart/src/server.rs                | 11 ++++++-----
 5 files changed, 15 insertions(+), 12 deletions(-)

diff --git a/actix-http/src/header/mod.rs b/actix-http/src/header/mod.rs
index 308cb0123..381842e74 100644
--- a/actix-http/src/header/mod.rs
+++ b/actix-http/src/header/mod.rs
@@ -38,13 +38,14 @@ pub mod map;
 mod shared;
 mod utils;
 
-#[doc(hidden)]
-pub use self::shared::*;
-
 pub use self::as_name::AsHeaderName;
 pub use self::into_pair::IntoHeaderPair;
 pub use self::into_value::IntoHeaderValue;
 pub use self::map::HeaderMap;
+pub use self::shared::{
+    parse_extended_value, q, Charset, ContentEncoding, ExtendedValue, HttpDate,
+    LanguageTag, Quality, QualityItem,
+};
 pub use self::utils::{
     fmt_comma_delimited, from_comma_delimited, from_one_raw_str, http_percent_encode,
 };
diff --git a/actix-http/src/header/shared/quality.rs b/actix-http/src/header/shared/quality.rs
index b26080917..80c823f1b 100644
--- a/actix-http/src/header/shared/quality.rs
+++ b/actix-http/src/header/shared/quality.rs
@@ -128,7 +128,7 @@ impl TryFrom<f32> for Quality {
     }
 }
 
-/// Convenience function to create a [`Quality`] from a `u16` (0–1000) or `f32` (0.0–1.0).
+/// Convenience function to create a [`Quality`] from an `f32` (0.0–1.0).
 ///
 /// Not recommended for use with user input. Rely on the `TryFrom` impls where possible.
 ///
diff --git a/actix-http/src/header/shared/quality_item.rs b/actix-http/src/header/shared/quality_item.rs
index 986637150..ac1e2b80b 100644
--- a/actix-http/src/header/shared/quality_item.rs
+++ b/actix-http/src/header/shared/quality_item.rs
@@ -7,7 +7,7 @@ use super::Quality;
 /// Represents an item with a quality value as defined
 /// in [RFC 7231 §5.3.1](https://datatracker.ietf.org/doc/html/rfc7231#section-5.3.1).
 ///
-/// # Parsing
+/// # Parsing and Formatting
 /// This wrapper be used to parse header value items that have a q-factor annotation as well as
 /// serialize items with a their q-factor.
 ///
diff --git a/actix-http/src/header/utils.rs b/actix-http/src/header/utils.rs
index a23f5b751..f4f34d347 100644
--- a/actix-http/src/header/utils.rs
+++ b/actix-http/src/header/utils.rs
@@ -65,8 +65,9 @@ where
     Ok(())
 }
 
-/// Percent encode a sequence of bytes with a character set defined in
-/// <https://datatracker.ietf.org/doc/html/rfc5987#section-3.2>
+/// Percent encode a sequence of bytes with a character set defined in [RFC 5987 §3.2].
+///
+/// [RFC 5987 §3.2]: https://datatracker.ietf.org/doc/html/rfc5987#section-3.2
 #[inline]
 pub fn http_percent_encode(f: &mut fmt::Formatter<'_>, bytes: &[u8]) -> fmt::Result {
     let encoded = percent_encoding::percent_encode(bytes, HTTP_VALUE);
diff --git a/actix-multipart/src/server.rs b/actix-multipart/src/server.rs
index 23397b7ee..8eabcee10 100644
--- a/actix-multipart/src/server.rs
+++ b/actix-multipart/src/server.rs
@@ -435,10 +435,10 @@ impl Field {
 
     /// Returns the field's Content-Disposition.
     ///
-    /// Per [RFC 7578 §4.2]: 'Each part MUST contain a Content-Disposition header field where the
-    /// disposition type is "form-data". The Content-Disposition header field MUST also contain an
-    /// additional parameter of "name"; the value of the "name" parameter is the original field name
-    /// from the form.'
+    /// Per [RFC 7578 §4.2]: "Each part MUST contain a Content-Disposition header field where the
+    /// disposition type is `form-data`. The Content-Disposition header field MUST also contain an
+    /// additional parameter of `name`; the value of the `name` parameter is the original field name
+    /// from the form."
     ///
     /// This crate validates that it exists before returning a `Field`. As such, it is safe to
     /// unwrap `.content_disposition().get_name()`. The [name](Self::name) method is provided as
@@ -451,7 +451,8 @@ impl Field {
 
     /// Returns the field's name.
     ///
-    /// See [content_disposition] regarding guarantees about
+    /// See [content_disposition](Self::content_disposition) regarding guarantees about existence of
+    /// the name field.
     pub fn name(&self) -> &str {
         self.content_disposition()
             .get_name()