]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
gh-98347: Add links to python-isal in the documentation (#98637)
authorRuben Vorderman <r.h.p.vorderman@lumc.nl>
Fri, 25 Apr 2025 01:53:23 +0000 (03:53 +0200)
committerGitHub <noreply@github.com>
Fri, 25 Apr 2025 01:53:23 +0000 (01:53 +0000)
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>
Doc/library/gzip.rst
Doc/library/zlib.rst

index 4222f1bb1f49aef160c733bd4ea259e69afa3550..c9d96085ef739d7b3cad6c544cb27dbead763a3b 100644 (file)
@@ -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
 
index db0537f8ccc0a69e465c68ed4a55db0192a2593d..75ead3c4cb144c26ba0d4898f074f076394951bb 100644 (file)
@@ -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