diff options
| author | Martin Panter <vadmium+py@gmail.com> | 2016-05-27 07:32:11 +0000 |
|---|---|---|
| committer | Martin Panter <vadmium+py@gmail.com> | 2016-05-27 07:32:11 +0000 |
| commit | c284ac9a7935131cb90662b3fae3e0822587a60a (patch) | |
| tree | 0bb53f34a46df692060842ea68cfb0a6451559a8 /Modules/clinic | |
| parent | 63047dc197203c96521ed7202a236910799cbb07 (diff) | |
| download | cpython-c284ac9a7935131cb90662b3fae3e0822587a60a.tar.gz | |
Issue #5784: Expand documentation and tests for zlib wbits parameter
Based on documentation by AM Kuchling.
Diffstat (limited to 'Modules/clinic')
| -rw-r--r-- | Modules/clinic/zlibmodule.c.h | 11 |
1 files changed, 7 insertions, 4 deletions
diff --git a/Modules/clinic/zlibmodule.c.h b/Modules/clinic/zlibmodule.c.h index 2d75bc912e..602ae1df82 100644 --- a/Modules/clinic/zlibmodule.c.h +++ b/Modules/clinic/zlibmodule.c.h @@ -48,7 +48,7 @@ PyDoc_STRVAR(zlib_decompress__doc__, " data\n" " Compressed data.\n" " wbits\n" -" The window buffer size.\n" +" The window buffer size and container format.\n" " bufsize\n" " The initial output buffer size."); @@ -95,7 +95,10 @@ PyDoc_STRVAR(zlib_compressobj__doc__, " method\n" " The compression algorithm. If given, this must be DEFLATED.\n" " wbits\n" -" The base two logarithm of the window size (range: 8..15).\n" +" +9 to +15: The base-two logarithm of the window size. Include a zlib\n" +" container.\n" +" -9 to -15: Generate a raw stream.\n" +" +25 to +31: Include a gzip container.\n" " memLevel\n" " Controls the amount of memory used for internal compression state.\n" " Valid values range from 1 to 9. Higher values result in higher memory\n" @@ -146,7 +149,7 @@ PyDoc_STRVAR(zlib_decompressobj__doc__, "Return a decompressor object.\n" "\n" " wbits\n" -" The window buffer size.\n" +" The window buffer size and container format.\n" " zdict\n" " The predefined compression dictionary. This must be the same\n" " dictionary as used by the compressor that produced the input data."); @@ -439,4 +442,4 @@ exit: #ifndef ZLIB_COMPRESS_COPY_METHODDEF #define ZLIB_COMPRESS_COPY_METHODDEF #endif /* !defined(ZLIB_COMPRESS_COPY_METHODDEF) */ -/*[clinic end generated code: output=cf81e1deae3af0ce input=a9049054013a1b77]*/ +/*[clinic end generated code: output=f31627b314a7bd2f input=a9049054013a1b77]*/ |