mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-07-30 06:34:15 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

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

Browse source
This commit is contained in:
Georg Brandl 2006-04-01 07:39:41 +00:00
parent dcfdae7d72
commit 22a9dc889d
2 changed files with 7 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

5
Doc/lib/libzlib.tex
View file

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

4
Modules/zlibmodule.c
View file

@ -654,7 +654,9 @@ PyZlib_flush(compobject *self, PyObject *args)
} }
PyDoc_STRVAR(decomp_flush__doc__, 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" "\n"
"The decompressor object can no longer be used after this call."); "The decompressor object can no longer be used after this call.");