Patch #1459631: documnent zlib.Decompress.flush() length parameter.

 (backport from rev. 43525)

diff --git a/Doc/lib/libzlib.tex b/Doc/lib/libzlib.tex
index a387ee9d71187088b8a828e09ddfe93a7037879a..40ee7659464b5f31e129dfec06eec7f05f7e56f9 100644 (file)
--- a/Doc/lib/libzlib.tex
+++ b/Doc/lib/libzlib.tex
@@ -162,11 +162,14 @@ continue.  If \var{max_length} is not supplied then the whole input is
 decompressed, and \member{unconsumed_tail} is an empty string.
 \end{methoddesc}
 
-\begin{methoddesc}[Decompress]{flush}{}
+\begin{methoddesc}[Decompress]{flush}{\optional{length}}
 All pending input is processed, and a string containing the remaining
 uncompressed output is returned.  After calling \method{flush()}, the
 \method{decompress()} method cannot be called again; the only realistic
 action is to delete the object.
+
+The optional parameter \var{length} sets the initial size of the
+output buffer.
 \end{methoddesc}
 
 \begin{seealso}

diff --git a/Modules/zlibmodule.c b/Modules/zlibmodule.c
index a598ae31c31fe6e75feda2e4a23dd6961e6c9106..954984a243884c9484e083472746eebf64b63978 100644 (file)
--- a/Modules/zlibmodule.c
+++ b/Modules/zlibmodule.c
@@ -654,7 +654,9 @@ PyZlib_flush(compobject *self, PyObject *args)
 }
 
 PyDoc_STRVAR(decomp_flush__doc__,
-"flush() -- Return a string containing any remaining decompressed data.\n"
+"flush( [length] ) -- Return a string containing any remaining\n"
+"decompressed data. length, if given, is the initial size of the\n"
+"output buffer.\n"
 "\n"
 "The decompressor object can no longer be used after this call.");