Skip to content

gh-131885: Use real signatures in the zlib docs #156179

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

Open
StanFromIreland wants to merge 1 commit into
base: main
Choose a base branch
from
+7 −7
Open

gh-131885: Use real signatures in the zlib docs #156179

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
14 changes: 7 additions & 7 deletions Doc/library/zlib.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ The available exception and functions in this module are:
Exception raised on compression and decompression errors.


.. function:: adler32(data[, value])
.. function:: adler32(data, value=1, /)

Computes an Adler-32 checksum of *data*. (An Adler-32 checksum is almost as
reliable as a CRC32 but can be computed much more quickly.) The result
Expand Down Expand Up @@ -127,7 +127,7 @@ The available exception and functions in this module are:
Added the *zdict* parameter and keyword argument support.


.. function:: crc32(data[, value])
.. function:: crc32(data, value=0, /)

.. index::
single: Cyclic Redundancy Check
Expand Down Expand Up @@ -205,7 +205,7 @@ The available exception and functions in this module are:
.. versionchanged:: 3.6
*wbits* and *bufsize* can be used as keyword arguments.

.. function:: decompressobj(wbits=MAX_WBITS[, zdict])
.. function:: decompressobj(wbits=MAX_WBITS, zdict=b'')

Returns a decompression object, to be used for decompressing data streams that
won't fit into memory at once.
Expand All @@ -231,15 +231,15 @@ The available exception and functions in this module are:
Compression objects support the following methods:


.. method:: Compress.compress(data)
.. method:: Compress.compress(data, /)

Compress *data*, returning a bytes object containing compressed data for at least
part of the data in *data*. This data should be concatenated to the output
produced by any preceding calls to the :meth:`compress` method. Some input may
be kept in internal buffers for later processing.


.. method:: Compress.flush([mode])
.. method:: Compress.flush(mode=Z_FINISH, /)

All pending input is processed, and a bytes object containing the remaining compressed
output is returned. *mode* can be selected from the constants
Expand Down Expand Up @@ -294,7 +294,7 @@ Decompression objects support the following methods and attributes:
.. versionadded:: 3.3


.. method:: Decompress.decompress(data, max_length=0)
.. method:: Decompress.decompress(data, /, max_length=0)

Decompress *data*, returning a bytes object containing the uncompressed data
corresponding to at least part of the data in *string*. This data should be
Expand All @@ -318,7 +318,7 @@ Decompression objects support the following methods and attributes:
*max_length* can be used as a keyword argument.


.. method:: Decompress.flush([length])
.. method:: Decompress.flush(length=DEF_BUF_SIZE, /)

All pending input is processed, and a bytes object containing the remaining
uncompressed output is returned. After calling :meth:`flush`, the
Expand Down
Loading