mirror of
https://github.com/python/cpython.git
synced 2025-07-29 14:15:07 +00:00
Patch #1459631: documnent zlib.Decompress.flush() length parameter.
This commit is contained in:
parent
dcfdae7d72
commit
22a9dc889d
2 changed files with 7 additions and 2 deletions
|
@ -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.
|
||||
\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}
|
||||
|
|
|
@ -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.");
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue