Commit 1d269c10 authored by Martin Panter's avatar Martin Panter

Issue #26244: Clarify default zlib compression level in documentation

Based on patch by Aviv Palivoda.
parent 886aba47
......@@ -71,10 +71,12 @@ The available exception and functions in this module are:
.. function:: compressobj([level[, method[, wbits[, memlevel[, strategy]]]]])
Returns a compression object, to be used for compressing data streams that won't
fit into memory at once. *level* is an integer from ``0`` to ``9`` controlling
fit into memory at once. *level* is an integer from
``0`` to ``9`` or ``-1``, controlling
the level of compression; ``1`` is fastest and produces the least compression,
``9`` is slowest and produces the most. ``0`` is no compression. The default
value is ``6``.
value is ``-1`` (Z_DEFAULT_COMPRESSION). Z_DEFAULT_COMPRESSION represents a default
compromise between speed and compression (currently equivalent to level 6).
*method* is the compression algorithm. Currently, the only supported value is
``DEFLATED``.
......
......@@ -1019,6 +1019,7 @@ Joonas Paalasmaa
Martin Packman
Shriphani Palakodety
Julien Palard
Aviv Palivoda
Ondrej Palkovsky
Mike Pall
Todd R. Palmer
......
......@@ -101,7 +101,7 @@ zlib_error(z_stream zst, int err, char *msg)
PyDoc_STRVAR(compressobj__doc__,
"compressobj([level]) -- Return a compressor object.\n"
"\n"
"Optional arg level is the compression level, in 0-9.");
"Optional arg level is the compression level, in 0-9 or -1.");
PyDoc_STRVAR(decompressobj__doc__,
"decompressobj([wbits]) -- Return a decompressor object.\n"
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment