classification
Title: zlib compressobj: missing parameter doc strings
Type: enhancement Stage: resolved
Components: Documentation, Library (Lib) Versions: Python 2.7
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: docs@python Nosy List: docs@python, oberstet, python-dev, r.david.murray
Priority: normal Keywords:

Created on 2013-10-17 07:55 by oberstet, last changed 2013-10-17 18:02 by r.david.murray. This issue is now closed.

Messages (2)
msg200113 - (view) Author: Tobias Oberstein (oberstet) Date: 2013-10-17 07:55
Currently the `zlib` module documents

    zlib.compressobj([level])

However, there are more parameters present already today:

    zlib.compressobj([level, method, wbits])

These other parameters are used in at least 2 deployed libraries (in the context of WebSocket compression):

https://github.com/tavendo/AutobahnPython/blob/master/autobahn/autobahn/compress_deflate.py#L527

http://code.google.com/p/pywebsocket/source/browse/trunk/src/mod_pywebsocket/util.py#231
msg200150 - (view) Author: Roundup Robot (python-dev) (Python triager) Date: 2013-10-17 17:50
New changeset c54c8e71b79a by Georg Brandl in branch '2.7':
Closes #19277: document all parameters of compressobj().
http://hg.python.org/cpython/rev/c54c8e71b79a
History
Date User Action Args
2013-10-17 18:02:00r.david.murraysetmessages: - msg200151
2013-10-17 18:01:41r.david.murraysetnosy: + r.david.murray
messages: + msg200151
2013-10-17 17:50:30python-devsetstatus: open -> closed

nosy: + python-dev
messages: + msg200150

resolution: fixed
stage: resolved
2013-10-17 07:55:31oberstetcreate