[Python-checkins] cpython (2.7): Closes #19277: document all parameters of compressobj().

[georg.brandl]

http://hg.python.org/cpython/rev/c54c8e71b79a
changeset:   86407:c54c8e71b79a
branch:      2.7
parent:      86392:73dad296c483
user:        Georg Brandl <georg at python.org>
date:        Thu Oct 17 19:51:00 2013 +0200
summary:
  Closes #19277: document all parameters of compressobj().

files:
  Doc/library/zlib.rst |  17 ++++++++++++++++-
  1 files changed, 16 insertions(+), 1 deletions(-)


diff --git a/Doc/library/zlib.rst b/Doc/library/zlib.rst
--- a/Doc/library/zlib.rst
+++ b/Doc/library/zlib.rst
@@ -68,7 +68,7 @@
    Raises the :exc:`error` exception if any error occurs.
 
 
-.. function:: compressobj([level])
+.. 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
@@ -76,6 +76,21 @@
    ``9`` is slowest and produces the most.  ``0`` is no compression.  The default
    value is ``6``.
 
+   *method* is the compression algorithm. Currently, the only supported value is
+   ``DEFLATED``.
+
+   *wbits* is the base two logarithm of the size of the window buffer. This
+   should be an integer from ``8`` to ``15``. Higher values give better
+   compression, but use more memory. The default is 15.
+
+   *memlevel* controls the amount of memory used for internal compression state.
+   Valid values range from ``1`` to ``9``. Higher values using more memory,
+   but are faster and produce smaller output. The default is 8.
+
+   *strategy* is used to tune the compression algorithm. Possible values are
+   ``Z_DEFAULT_STRATEGY``, ``Z_FILTERED``, and ``Z_HUFFMAN_ONLY``. The default
+   is ``Z_DEFAULT_STRATEGY``.
+
 
 .. function:: crc32(data[, value])
 

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