Skip to content

Commit 93fb365

Browse files
[3.13] gh-131885: Use real signatures in the zlib docs (GH-156179) (#156267)
(cherry picked from commit d5e560e) Co-authored-by: Stan Ulbrych <stan@python.org>
1 parent df8d214 commit 93fb365

1 file changed

Lines changed: 7 additions & 7 deletions

File tree

Doc/library/zlib.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ The available exception and functions in this module are:
2929
Exception raised on compression and decompression errors.
3030

3131

32-
.. function:: adler32(data[, value])
32+
.. function:: adler32(data, value=1, /)
3333

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

117117

118-
.. function:: crc32(data[, value])
118+
.. function:: crc32(data, value=0, /)
119119

120120
.. index::
121121
single: Cyclic Redundancy Check
@@ -179,7 +179,7 @@ The available exception and functions in this module are:
179179
.. versionchanged:: 3.6
180180
*wbits* and *bufsize* can be used as keyword arguments.
181181

182-
.. function:: decompressobj(wbits=MAX_WBITS[, zdict])
182+
.. function:: decompressobj(wbits=MAX_WBITS, zdict=b'')
183183

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

207207

208-
.. method:: Compress.compress(data)
208+
.. method:: Compress.compress(data, /)
209209

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

215215

216-
.. method:: Compress.flush([mode])
216+
.. method:: Compress.flush(mode=Z_FINISH, /)
217217

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

270270

271-
.. method:: Decompress.decompress(data, max_length=0)
271+
.. method:: Decompress.decompress(data, /, max_length=0)
272272

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

289289

290-
.. method:: Decompress.flush([length])
290+
.. method:: Decompress.flush(length=DEF_BUF_SIZE, /)
291291

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

0 commit comments

Comments
 (0)