Skip to content

[3.13] gh-98347: Add links to python-isal in the documentation (GH-98637) #132894

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
AA-Turner merged 1 commit into from
Apr 25, 2025
Merged

[3.13] gh-98347: Add links to python-isal in the documentation (GH-98637) #132894

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
gh-98347: Add links to python-isal in the documentation (GH-98637) 
Clearly note that this is primarily intended for users for who zlib/gzip is a bottleneck.
(cherry picked from commit b1fc8b6)

Co-authored-by: Ruben Vorderman <r.h.p.vorderman@lumc.nl>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
  • Loading branch information
@rhpvorderman @AA-Turner @miss-islington
2 people authored and miss-islington committed Apr 25, 2025
commit e38fc824c7a5a1dff3f3cbe943974a9e2708edf6
4 changes: 4 additions & 0 deletions Doc/library/gzip.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -253,6 +253,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

Expand Down
5 changes: 5 additions & 0 deletions Doc/library/zlib.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -341,3 +341,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
Loading