From f1634392079fb708f7a3e8429e38fc57325da7b9 Mon Sep 17 00:00:00 2001 From: Ruben Vorderman Date: Tue, 25 Oct 2022 09:33:28 +0200 Subject: [PATCH 1/2] Add links to python-isal in the documentation Clearly note that this is primarily intended for users for who zlib/gzip is a bottleneck. --- Doc/library/gzip.rst | 3 +++ Doc/library/zlib.rst | 4 ++++ 2 files changed, 7 insertions(+) diff --git a/Doc/library/gzip.rst b/Doc/library/gzip.rst index 1a2582d6a904b2..c41b0352c5c243 100644 --- a/Doc/library/gzip.rst +++ b/Doc/library/gzip.rst @@ -241,6 +241,9 @@ 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. .. program:: gzip diff --git a/Doc/library/zlib.rst b/Doc/library/zlib.rst index ac179722dee2be..fc35612cf50a5a 100644 --- a/Doc/library/zlib.rst +++ b/Doc/library/zlib.rst @@ -341,3 +341,7 @@ 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 zlib-compatible (de)compression is a bottleneck the `python-isal + `_ package speeds up + (de)compression with a mostly compatible API. From 5dcdb9e6ba7989cd80a9cd318aeda620d4256ae1 Mon Sep 17 00:00:00 2001 From: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Date: Fri, 25 Apr 2025 02:46:55 +0100 Subject: [PATCH 2/2] Style --- Doc/library/gzip.rst | 7 ++++--- Doc/library/zlib.rst | 7 ++++--- 2 files changed, 8 insertions(+), 6 deletions(-) diff --git a/Doc/library/gzip.rst b/Doc/library/gzip.rst index a36985aae33c56..c9d96085ef739d 100644 --- a/Doc/library/gzip.rst +++ b/Doc/library/gzip.rst @@ -258,9 +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. + 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 7d1fe608ec5632..75ead3c4cb144c 100644 --- a/Doc/library/zlib.rst +++ b/Doc/library/zlib.rst @@ -354,6 +354,7 @@ the following constants: The zlib manual explains the semantics and usage of the library's many functions. - In case zlib-compatible (de)compression is a bottleneck the `python-isal - `_ package speeds up - (de)compression with a mostly compatible API. + 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