Skip to content

[3.10] bpo-47040: improve document of checksum functions (GH-31955) #32002

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
merged 3 commits into from Mar 20, 2022
Merged

[3.10] bpo-47040: improve document of checksum functions (GH-31955) #32002

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7d50d3e
bpo-47040: improve document of checksum functions (gh-31955)
animalize Mar 19, 2022
11fa8dc
remove code polish
wjssz Mar 20, 2022
07dd5ce
no need for a news entry for minor documentation updates.
gpshead Mar 20, 2022
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
7 changes: 3 additions & 4 deletions Doc/library/binascii.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ The :mod:`binascii` module defines the following functions:

.. function:: crc32(data[, value])

Compute CRC-32, the 32-bit checksum of *data*, starting with an
Compute CRC-32, the unsigned 32-bit checksum of *data*, starting with an
initial CRC of *value*. The default initial CRC is zero. The algorithm
is consistent with the ZIP file checksum. Since the algorithm is designed for
use as a checksum algorithm, it is not suitable for use as a general hash
Expand All @@ -149,9 +149,8 @@ The :mod:`binascii` module defines the following functions:

.. versionchanged:: 3.0
The result is always unsigned.
To generate the same numeric value across all Python versions and
platforms, use ``crc32(data) & 0xffffffff``.

To generate the same numeric value when using Python 2 or earlier,
use ``crc32(data) & 0xffffffff``.

.. function:: b2a_hex(data[, sep[, bytes_per_sep=1]])
hexlify(data[, sep[, bytes_per_sep=1]])
Expand Down
14 changes: 6 additions & 8 deletions Doc/library/zlib.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,10 +42,9 @@ The available exception and functions in this module are:
for use as a general hash algorithm.

.. versionchanged:: 3.0
Always returns an unsigned value.
To generate the same numeric value across all Python versions and
platforms, use ``adler32(data) & 0xffffffff``.

The result is always unsigned.
To generate the same numeric value when using Python 2 or earlier,
use ``adler32(data) & 0xffffffff``.

.. function:: compress(data, /, level=-1)

Expand Down Expand Up @@ -127,10 +126,9 @@ The available exception and functions in this module are:
for use as a general hash algorithm.

.. versionchanged:: 3.0
Always returns an unsigned value.
To generate the same numeric value across all Python versions and
platforms, use ``crc32(data) & 0xffffffff``.

The result is always unsigned.
To generate the same numeric value when using Python 2 or earlier,
use ``crc32(data) & 0xffffffff``.

.. function:: decompress(data, /, wbits=MAX_WBITS, bufsize=DEF_BUF_SIZE)

Expand Down