Skip to content

Commit ed0238b

Browse files
committed
Order difference in order of disturbance
1 parent 4df22f6 commit ed0238b

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

README.rst

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,10 @@ Differences with zlib and gzip modules
130130
+ Compression level 0 in ``zlib`` and ``gzip`` means **no compression**, while
131131
in ``isal_zlib`` and ``igzip`` this is the **lowest compression level**.
132132
This is a design choice that was inherited from the ISA-L library.
133-
+ Compression levels range from 0 to 3, not 1 to 9.
133+
+ Compression levels range from 0 to 3, not 1 to 9. ``isal_zlib.Z_DEFAULT_COMPRESSION``
134+
has been aliased to ``isal_zlib.ISAL_DEFAULT_COMPRESSION`` (2).
135+
+ ``isal_zlib`` only supports ``NO_FLUSH``, ``SYNC_FLUSH``, ``FULL_FLUSH`` and
136+
``FINISH_FLUSH``. Other flush modes are not supported and will raise errors.
134137
+ ``zlib.Z_DEFAULT_STRATEGY``, ``zlib.Z_RLE`` etc. are exposed as
135138
``isal_zlib.Z_DEFAULT_STRATEGY``, ``isal_zlib.Z_RLE`` etc. for compatibility
136139
reasons. However, ``isal_zlib`` only supports a default strategy and will
@@ -139,11 +142,14 @@ Differences with zlib and gzip modules
139142
``isal_zlib`` supports memory levels smallest, small, medium, large and
140143
largest. These have been mapped to levels 1, 2-3, 4-6, 7-8 and 9. So
141144
``isal_zlib`` can be used with zlib compatible memory levels.
142-
+ ``isal_zlib`` only supports ``NO_FLUSH``, ``SYNC_FLUSH``, ``FULL_FLUSH`` and
143-
``FINISH_FLUSH``. Other flush modes are not supported and will raise errors.
145+
+ ``isal_zlib`` methods have a ``data`` argument which is positional only. In
146+
isal_zlib this is not enforced and it can also called as keyword argument.
147+
This is due to implementing ``isal_zlib`` in cython and maintaining backwards
148+
compatibility with python 3.6.
144149
+ ``igzip.open`` returns a class ``IGzipFile`` instead of ``GzipFile``. Since
145150
the compression levels are not compatible, a difference in naming was chosen
146-
to reflect this. ``igzip.GzipFile`` does exist as an alias however.
151+
to reflect this. ``igzip.GzipFile`` does exist as an alias of
152+
``igzip.IGzipFile`` for compatibility reasons.
147153

148154
Contributing
149155
------------

0 commit comments

Comments
 (0)