[Python-checkins] cpython (2.7): Issue #26244: Clarify default zlib compression level in documentation

[martin.panter]

https://hg.python.org/cpython/rev/650cf38fba28
changeset:   100144:650cf38fba28
branch:      2.7
parent:      100134:6f7b2b7a029a
user:        Martin Panter <vadmium+py at gmail.com>
date:        Wed Feb 03 07:06:33 2016 +0000
summary:
  Issue #26244: Clarify default zlib compression level in documentation

Based on patch by Aviv Palivoda.

files:
  Doc/library/zlib.rst |  6 ++++--
  Misc/ACKS            |  1 +
  Modules/zlibmodule.c |  2 +-
  3 files changed, 6 insertions(+), 3 deletions(-)


diff --git a/Doc/library/zlib.rst b/Doc/library/zlib.rst
--- a/Doc/library/zlib.rst
+++ b/Doc/library/zlib.rst
@@ -71,10 +71,12 @@
 .. 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``.
diff --git a/Misc/ACKS b/Misc/ACKS
--- a/Misc/ACKS
+++ b/Misc/ACKS
@@ -1019,6 +1019,7 @@
 Martin Packman
 Shriphani Palakodety
 Julien Palard
+Aviv Palivoda
 Ondrej Palkovsky
 Mike Pall
 Todd R. Palmer
diff --git a/Modules/zlibmodule.c b/Modules/zlibmodule.c
--- a/Modules/zlibmodule.c
+++ b/Modules/zlibmodule.c
@@ -101,7 +101,7 @@
 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"

-- 
Repository URL: https://hg.python.org/cpython