classification
Title: zlib decompressobj documentation typo
Type: Stage:
Components: Documentation Versions: Python 2.4
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: Nosy List: rhettinger, scott_daniels (2)
Priority: normal Keywords

Created on 2004-12-20 04:48 by scott_daniels, last changed 2004-12-20 06:09 by rhettinger.

Messages (2)
msg23783 - (view) Author: Scott David Daniels (scott_daniels) Date: 2004-12-20 04:48 
In both Python 2.3.4 and 2.4 Python Library 
Reference    
    7.15 zlib -- Compression compatible with gzip 
The documentation that describes zlib.decompressobj, 
the method description for the decompress message 
looks like:

    decompress( string) 
        [max_length] Decompress string, returning a ...

when it should be:

    decompress( string [, max_length]) 
        Decompress string, returning a ...
msg23784 - (view) Author: Raymond Hettinger (rhettinger) Date: 2004-12-20 06:09 
Logged In: YES 
user_id=80475

Fixed.

Thanks for the report.
History
Date User Action Args
2004-12-20 04:48:40scott_danielscreate