Skip to content

Commit b8ff494

Browse files
committed
Update documentation
1 parent d159e2c commit b8ff494

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

CHANGELOG.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ Changelog
99
1010
version 0.5.0-dev
1111
-----------------
12+
+ Fix a bug where negative integers were not allowed for the ``adler32`` and
13+
``crc32`` functions in ``isal_zlib``.
1214
+ Provided stubs (type-hint files) for ``isal_zlib`` and ``_isal`` modules.
1315
Package is now tested with mypy to ensure correct type information.
1416
+ The command-line interface now reads in blocks of 32K instead of 8K. This

README.rst

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -129,8 +129,6 @@ Differences with zlib and gzip modules
129129
in ``isal_zlib`` and ``igzip`` this is the **lowest compression level**.
130130
This is a design choice that was inherited from the ISA-L library.
131131
+ Compression levels range from 0 to 3, not 1 to 9.
132-
+ ``isal_zlib.crc32`` and ``isal_zlib.adler32`` do not support negative
133-
numbers for the value parameter.
134132
+ ``zlib.Z_DEFAULT_STRATEGY``, ``zlib.Z_RLE`` etc. are exposed as
135133
``isal_zlib.Z_DEFAULT_STRATEGY``, ``isal_zlib.Z_RLE`` etc. for compatibility
136134
reasons. However, ``isal_zlib`` only supports a default strategy and will

0 commit comments

Comments
 (0)