From 7e1398c2cf8956baa558c1d28866285e527d891c Mon Sep 17 00:00:00 2001
From: ByteBaker <42913098+ByteBaker@users.noreply.github.com>
Date: Mon, 23 Sep 2024 22:28:45 +0530
Subject: [PATCH] docs: correctly mention compression level - mention that
 `miniz` also provides a level 10

---
 src/lib.rs | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/src/lib.rs b/src/lib.rs
index d286ba2e..f0b31cde 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -192,6 +192,10 @@ impl Compression {
     ///
     /// The integer here is typically on a scale of 0-9 where 0 means "no
     /// compression" and 9 means "take as long as you'd like".
+    ///
+    /// It is worth noting that `flate2` supports both `zlib` and `miniz`
+    /// backends for compression, where `miniz` also provides a level `10` of
+    /// compression. The `zlib` backend only supports levels 0-9.
     pub const fn new(level: u32) -> Compression {
         Compression(level)
     }
@@ -213,7 +217,7 @@ impl Compression {
     }
 
     /// Returns an integer representing the compression level, typically on a
-    /// scale of 0-9
+    /// scale of 0-9. With `miniz` backend, level 10 is also possible.
     pub fn level(&self) -> u32 {
         self.0
     }