From: Ruben Vorderman Date: Fri, 25 Apr 2025 01:53:23 +0000 (+0200) Subject: gh-98347: Add links to python-isal in the documentation (#98637) X-Git-Tag: v3.14.0b1~307 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=b1fc8b69ec4c29026cd8786fc5da0c498c7dcd57;p=thirdparty%2FPython%2Fcpython.git gh-98347: Add links to python-isal in the documentation (#98637) Clearly note that this is primarily intended for users for who zlib/gzip is a bottleneck. Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> --- diff --git a/Doc/library/gzip.rst b/Doc/library/gzip.rst index 4222f1bb1f49..c9d96085ef73 100644 --- a/Doc/library/gzip.rst +++ b/Doc/library/gzip.rst @@ -258,6 +258,10 @@ Example of how to GZIP compress a binary string:: The basic data compression module needed to support the :program:`gzip` file format. + In case gzip (de)compression is a bottleneck, the `python-isal`_ + package speeds up (de)compression with a mostly compatible API. + + .. _python-isal: https://github.com/pycompression/python-isal .. program:: gzip diff --git a/Doc/library/zlib.rst b/Doc/library/zlib.rst index db0537f8ccc0..75ead3c4cb14 100644 --- a/Doc/library/zlib.rst +++ b/Doc/library/zlib.rst @@ -353,3 +353,8 @@ the following constants: http://www.zlib.net/manual.html The zlib manual explains the semantics and usage of the library's many functions. + + In case gzip (de)compression is a bottleneck, the `python-isal`_ + package speeds up (de)compression with a mostly compatible API. + + .. _python-isal: https://github.com/pycompression/python-isal