summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMartin Panter <vadmium+py@gmail.com>2015-11-18 00:59:17 (GMT)
committerMartin Panter <vadmium+py@gmail.com>2015-11-18 00:59:17 (GMT)
commit402803b642a011884d3c2cd0375e927ba2c6bf0c (patch)
tree5b87f86a4733f31509e9267b8c8e196a7487eced
parent793ae0d0ae02ce91c626472ca2b3e2f8d4d6229a (diff)
downloadcpython-402803b642a011884d3c2cd0375e927ba2c6bf0c.zip
cpython-402803b642a011884d3c2cd0375e927ba2c6bf0c.tar.gz
cpython-402803b642a011884d3c2cd0375e927ba2c6bf0c.tar.bz2
Issue #23200: Document that max_length=0 is not supported
-rw-r--r--Doc/library/zlib.rst2
1 files changed, 1 insertions, 1 deletions
diff --git a/Doc/library/zlib.rst b/Doc/library/zlib.rst
index 70e1483..96e723b 100644
--- a/Doc/library/zlib.rst
+++ b/Doc/library/zlib.rst
@@ -221,7 +221,7 @@ Decompression objects support the following methods, and two attributes:
:meth:`decompress` method. Some of the input data may be preserved in internal
buffers for later processing.
- If the optional parameter *max_length* is supplied then the return value will be
+ If the optional parameter *max_length* is non-zero then the return value will be
no longer than *max_length*. This may mean that not all of the compressed input
can be processed; and unconsumed data will be stored in the attribute
:attr:`unconsumed_tail`. This string must be passed to a subsequent call to