Improve comments and update changelog

snoyberg · Dec 12, 2024 · 91344ad · 91344ad
1 parent 725ffa1
commit 91344ad
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 7 deletions.
diff --git a/http-client/ChangeLog.md b/http-client/ChangeLog.md
@@ -1,5 +1,9 @@
 # Changelog for http-client
 
+## 0.7.18
+
+* Add the `managerSetMaxNumberHeaders` function to the `Client` module to configure `managerMaxNumberHeaders` in `ManagerSettings`.
+
 ## 0.7.17
 
 * Add `managerSetMaxHeaderLength` to `Client` to change `ManagerSettings` `MaxHeaderLength`.

diff --git a/http-client/Network/HTTP/Client/Types.hs b/http-client/Network/HTTP/Client/Types.hs
@@ -822,15 +822,17 @@ data ManagerSettings = ManagerSettings
     --
     -- Since 0.4.7
     , managerMaxHeaderLength :: Maybe MaxHeaderLength
-    -- ^ TODO
+    -- ^ Configure the maximum size, in bytes, of an HTTP header field.
+    -- Set it to `Nothing` to remove this limit  (eg: for debugging purposes).
     --
-    -- Default: TODO
+    -- Default: 4096
     --
-    -- @since TODO
+    -- @since 0.7.17
     , managerMaxNumberHeaders :: Maybe MaxNumberHeaders
-    -- ^ TODO
+    -- ^ Configure the maximum number of HTTP header fields.
+    -- Set it to `Nothing` to remove this limit (eg: for debugging purposes).
     --
-    -- Default: TODO
+    -- Default: 100
     --
     -- @since 0.7.18
     }
@@ -921,9 +923,9 @@ newtype MaxHeaderLength = MaxHeaderLength
     }
     deriving (Eq, Show, Ord, T.Typeable)
 
--- | The maximum number of header lines.
+-- | The maximum number of header fields.
 --
--- @since TODO
+-- @since 0.7.18
 newtype MaxNumberHeaders = MaxNumberHeaders
     { unMaxNumberHeaders :: Int
     }