diff options
| author | Georg Brandl <georg@python.org> | 2006-04-01 07:39:41 (GMT) |
|---|---|---|
| committer | Georg Brandl <georg@python.org> | 2006-04-01 07:39:41 (GMT) |
| commit | 22a9dc889df1e9d5a36e72004bc090f0b74b1902 (patch) | |
| tree | 7053d899adb1038ab6b646d5fa4c6276e2a3d263 /Doc | |
| parent | dcfdae7d72177d2897e3bd0eb4d3ef19dc51df08 (diff) | |
| download | cpython-22a9dc889df1e9d5a36e72004bc090f0b74b1902.zip cpython-22a9dc889df1e9d5a36e72004bc090f0b74b1902.tar.gz cpython-22a9dc889df1e9d5a36e72004bc090f0b74b1902.tar.bz2 | |
Patch #1459631: documnent zlib.Decompress.flush() length parameter.
Diffstat (limited to 'Doc')
| -rw-r--r-- | Doc/lib/libzlib.tex | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/Doc/lib/libzlib.tex b/Doc/lib/libzlib.tex index 2df8b85..dfbb43d 100644 --- a/Doc/lib/libzlib.tex +++ b/Doc/lib/libzlib.tex @@ -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} |