doc(core): add detailed document to Header encode method

hyperium · Jan 20, 2024 · 0f7c1c6 · 0f7c1c6
1 parent 03079f0
commit 0f7c1c6
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/headers-core/src/lib.rs b/headers-core/src/lib.rs
@@ -29,7 +29,8 @@ pub trait Header {
         Self: Sized,
         I: Iterator<Item = &'i HeaderValue>;
 
-    /// Encode this type to a [`HeaderValue`].
+    /// Encode this type to a [`HeaderValue`], and add it to a container
+    /// which has [`HeaderValue`] type as each element.
     ///
     /// This function should be infallible. Any errors converting to a
     /// `HeaderValue` should have been caught when parsing or constructing