[Python-checkins] r43526 - in python/branches/release24-maint: Doc/lib/libzlib.tex Modules/zlibmodule.c

georg.brandl python-checkins at python.org
Sat Apr 1 09:39:45 CEST 2006


Author: georg.brandl
Date: Sat Apr  1 09:39:45 2006
New Revision: 43526

Modified:
   python/branches/release24-maint/Doc/lib/libzlib.tex
   python/branches/release24-maint/Modules/zlibmodule.c
Log:
Patch #1459631: documnent zlib.Decompress.flush() length parameter.
 (backport from rev. 43525)

Modified: python/branches/release24-maint/Doc/lib/libzlib.tex
==============================================================================
--- python/branches/release24-maint/Doc/lib/libzlib.tex	(original)
+++ python/branches/release24-maint/Doc/lib/libzlib.tex	Sat Apr  1 09:39:45 2006
@@ -162,11 +162,14 @@
 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}

Modified: python/branches/release24-maint/Modules/zlibmodule.c
==============================================================================
--- python/branches/release24-maint/Modules/zlibmodule.c	(original)
+++ python/branches/release24-maint/Modules/zlibmodule.c	Sat Apr  1 09:39:45 2006
@@ -654,7 +654,9 @@
 }
 
 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.");
 


More information about the Python-checkins mailing list