Skip to content

Commit 161c992

Browse files
committed
Improve help text
1 parent 0d3f45b commit 161c992

File tree

1 file changed

+13
-5
lines changed

1 file changed

+13
-5
lines changed

shared-bindings/zlib/__init__.c

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -53,12 +53,20 @@
5353
//| size used during compression (8-15, the dictionary size is power of 2 of
5454
//| that value). Additionally, if value is positive, *data* is assumed to be
5555
//| zlib stream (with zlib header). Otherwise, if it's negative, it's assumed
56-
//| to be raw DEFLATE stream. *bufsize* parameter is for compatibility with
57-
//| CPython and is ignored.
56+
//| to be raw DEFLATE stream.
5857
//|
59-
//| :param ~bytes data: data to be decompressed
60-
//| :param ~int wbits: DEFLATE dictionary window size used during compression
61-
//| :param ~int bufsize: ignored for compatibility with CPython only
58+
//| The wbits parameter controls the size of the history buffer (or “window size”), and what header
59+
//| and trailer format is expected.
60+
//|
61+
//| Common wbits values:
62+
//|
63+
//| * To decompress deflate format, use wbits = -15
64+
//| * To decompress zlib format, use wbits = 15
65+
//| * To decompress gzip format, use wbits = 31
66+
//|
67+
//| :param bytes data: data to be decompressed
68+
//| :param int wbits: DEFLATE dictionary window size used during compression. See above.
69+
//| :param int bufsize: ignored for compatibility with CPython only
6270
//| """
6371
//| ...
6472
//|

0 commit comments

Comments
 (0)