diff options
| author | Martin Panter <vadmium+py@gmail.com> | 2016-02-03 07:06:33 (GMT) |
|---|---|---|
| committer | Martin Panter <vadmium+py@gmail.com> | 2016-02-03 07:06:33 (GMT) |
| commit | 567d513b9bf24ea5f58c4ca0fc3e25c887b85dcf (patch) | |
| tree | 7ce3408a0c559d47f1043ee266ff9b920698f976 /Modules | |
| parent | b00da57561505eb220a107fab0e7fbc322f767ac (diff) | |
| download | cpython-567d513b9bf24ea5f58c4ca0fc3e25c887b85dcf.zip cpython-567d513b9bf24ea5f58c4ca0fc3e25c887b85dcf.tar.gz cpython-567d513b9bf24ea5f58c4ca0fc3e25c887b85dcf.tar.bz2 | |
Issue #26244: Clarify default zlib compression level in documentation
Based on patch by Aviv Palivoda.
Diffstat (limited to 'Modules')
| -rw-r--r-- | Modules/clinic/zlibmodule.c.h | 7 | ||||
| -rw-r--r-- | Modules/zlibmodule.c | 7 |
2 files changed, 8 insertions, 6 deletions
diff --git a/Modules/clinic/zlibmodule.c.h b/Modules/clinic/zlibmodule.c.h index c5cdf42..2d75bc9 100644 --- a/Modules/clinic/zlibmodule.c.h +++ b/Modules/clinic/zlibmodule.c.h @@ -89,8 +89,9 @@ PyDoc_STRVAR(zlib_compressobj__doc__, "Return a compressor object.\n" "\n" " level\n" -" The compression level (an integer in the range 0-9; default is 6).\n" -" Higher compression levels are slower, but produce smaller results.\n" +" The compression level (an integer in the range 0-9 or -1; default is\n" +" currently equivalent to 6). Higher compression levels are slower,\n" +" but produce smaller results.\n" " method\n" " The compression algorithm. If given, this must be DEFLATED.\n" " wbits\n" @@ -438,4 +439,4 @@ exit: #ifndef ZLIB_COMPRESS_COPY_METHODDEF #define ZLIB_COMPRESS_COPY_METHODDEF #endif /* !defined(ZLIB_COMPRESS_COPY_METHODDEF) */ -/*[clinic end generated code: output=7734aec079550bc8 input=a9049054013a1b77]*/ +/*[clinic end generated code: output=cf81e1deae3af0ce input=a9049054013a1b77]*/ diff --git a/Modules/zlibmodule.c b/Modules/zlibmodule.c index d5a6e53..11a34bb 100644 --- a/Modules/zlibmodule.c +++ b/Modules/zlibmodule.c @@ -390,8 +390,9 @@ zlib_decompress_impl(PyModuleDef *module, Py_buffer *data, int wbits, zlib.compressobj level: int(c_default="Z_DEFAULT_COMPRESSION") = Z_DEFAULT_COMPRESSION - The compression level (an integer in the range 0-9; default is 6). - Higher compression levels are slower, but produce smaller results. + The compression level (an integer in the range 0-9 or -1; default is + currently equivalent to 6). Higher compression levels are slower, + but produce smaller results. method: int(c_default="DEFLATED") = DEFLATED The compression algorithm. If given, this must be DEFLATED. wbits: int(c_default="MAX_WBITS") = MAX_WBITS @@ -413,7 +414,7 @@ Return a compressor object. static PyObject * zlib_compressobj_impl(PyModuleDef *module, int level, int method, int wbits, int memLevel, int strategy, Py_buffer *zdict) -/*[clinic end generated code: output=2949bbb9a5723ccd input=b034847f8821f6af]*/ +/*[clinic end generated code: output=2949bbb9a5723ccd input=de2ffab6e910cd8b]*/ { compobject *self = NULL; int err; |