Skip to content

Commit c67d7ba

Browse files
authored
Address doc review's feedback
1 parent c8a96c8 commit c67d7ba

File tree

1 file changed

+14
-6
lines changed

1 file changed

+14
-6
lines changed

Doc/library/zlib.rst

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -48,9 +48,13 @@ The available exception and functions in this module are:
4848

4949
Combine two Adler-32 checksums into one.
5050

51-
Given an Adler-32 check value *adler1* of a sequence A and an Adler-32 check
52-
value *adler2* of a sequence B of length *len2*, the returned checksum
53-
is the Adler-32 check value of A and B concatenated.
51+
Given the Adler-32 checksum *adler1* of a sequence ``A`` and the
52+
Adler-32 checksum *adler2* of a sequence ``B`` of length *len2*,
53+
return the Adler-32 checksum of ``A`` and ``B`` concatenated.
54+
55+
This function is typically useful to combine Adler-32 checksums
56+
that were concurrently computed. To compute checksums from a stream
57+
of chunks, use :func:`adler32` sequentially instead.
5458

5559
.. versionadded:: next
5660

@@ -150,9 +154,13 @@ The available exception and functions in this module are:
150154

151155
Combine two CRC-32 checksums into one.
152156

153-
Given a CRC-32 check value *crc1* of a sequence A and a CRC-32 check
154-
value *crc2* of a sequence B of length *len2*, the returned checksum
155-
is the CRC-32 check value of A and B concatenated.
157+
Given the CRC-32 checksum *crc1* of a sequence ``A`` and the
158+
CRC-32 checksum *crc2* of a sequence ``B`` of length *len2*,
159+
return the CRC-32 checksum of ``A`` and ``B`` concatenated.
160+
161+
This function is typically useful to combine CRC-32 checksums
162+
that were concurrently computed. To compute checksums from a
163+
stream of chunks, use :func:`crc32` sequentially instead.
156164

157165
.. versionadded:: next
158166

0 commit comments

Comments
 (0)