djsundog
/
circuitpython
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Improve help text

This commit is contained in:
gamblor21 2022-04-02 09:19:30 -05:00
parent 0d3f45bef8
commit 161c992fa0
1 changed files with 13 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
shared-bindings/zlib/__init__.c
View File

@ -53,12 +53,20 @@
//| size used during compression (8-15, the dictionary size is power of 2 of
//| that value). Additionally, if value is positive, *data* is assumed to be
//| zlib stream (with zlib header). Otherwise, if it's negative, it's assumed
//| to be raw DEFLATE stream. *bufsize* parameter is for compatibility with
//| CPython and is ignored.
//| to be raw DEFLATE stream.
//|
//| :param ~bytes data: data to be decompressed
//| :param ~int wbits: DEFLATE dictionary window size used during compression
//| :param ~int bufsize: ignored for compatibility with CPython only
//| The wbits parameter controls the size of the history buffer (or “window size”), and what header
//| and trailer format is expected.
//|
//| Common wbits values:
//|
//| * To decompress deflate format, use wbits = -15
//| * To decompress zlib format, use wbits = 15
//| * To decompress gzip format, use wbits = 31
//|
//| :param bytes data: data to be decompressed
//| :param int wbits: DEFLATE dictionary window size used during compression. See above.
//| :param int bufsize: ignored for compatibility with CPython only
//| """
//| ...
//|