bumped version, added to ChangeLog and added documentation to 'defaul…

…tGzipSettings'
yesodweb · Dec 17, 2023 · e7865d1 · e7865d1
1 parent cf4d355
commit e7865d1
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 1 deletion.
diff --git a/wai-extra/ChangeLog.md b/wai-extra/ChangeLog.md
@@ -1,5 +1,9 @@
 # Changelog for wai-extra
 
+## 3.1.14.0
+
+* `defaultGzipSettings` now exported to not depend on `Data.Default` [#959](https://github.com/yesodweb/wai/pull/959)
+
 ## 3.1.13.0
 
 * Added `Combine Headers` `Middleware` [#901](https://github.com/yesodweb/wai/pull/901)

diff --git a/wai-extra/Network/Wai/Middleware/Gzip.hs b/wai-extra/Network/Wai/Middleware/Gzip.hs
@@ -200,6 +200,13 @@ data GzipFiles
 instance Default GzipSettings where
     def = defaultGzipSettings
 
+-- | Default settings for the 'gzip' middleware.
+--
+-- * Does not compress files.
+-- * Uses 'defaultCheckMime'.
+-- * Compession threshold set to 860 bytes.
+--
+-- @since 3.1.14.0
 defaultGzipSettings :: GzipSettings
 defaultGzipSettings = GzipSettings GzipIgnore defaultCheckMime minimumLength
 

diff --git a/wai-extra/wai-extra.cabal b/wai-extra/wai-extra.cabal
@@ -1,5 +1,5 @@
 Name:                wai-extra
-Version:             3.1.13.0
+Version:             3.1.14.0
 Synopsis:            Provides some basic WAI handlers and middleware.
 description:
   Provides basic WAI handler and middleware functionality: