Skip to content

Commit 07d4fbc

Browse files
authored
Notify users of a difference between gzip and igzip
1 parent 03e98dc commit 07d4fbc

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

README.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -133,6 +133,9 @@ Differences with zlib and gzip modules
133133
in ``isal_zlib`` and ``igzip`` this is the **lowest compression level**.
134134
This is a design choice that was inherited from the ISA-L library.
135135
+ Compression levels range from 0 to 3, not 1 to 9.
136+
+ ``igzip`` contains a class ``IGzipFile`` instead of ``GzipFile``. Since the
137+
compression levels are not compatible, a difference in naming was chosen to
138+
reflect this.
136139
+ ``zlib.Z_DEFAULT_STRATEGY``, ``zlib.Z_RLE`` etc. are exposed as
137140
``isal_zlib.Z_DEFAULT_STRATEGY``, ``isal_zlib.Z_RLE`` etc. for compatibility
138141
reasons. However, ``isal_zlib`` only supports a default strategy and will

0 commit comments

Comments
 (0)