[docs] [issue27311] Incorrect documentation for zipfile.writestr()

John Hagen report at bugs.python.org
Mon Jun 13 20:42:21 EDT 2016


New submission from John Hagen:

The function signature and description for zipfile.writestr is incorrect:

https://docs.python.org/3.5/library/zipfile.html#zipfile.ZipFile.writestr

See:
https://github.com/python/cpython/blob/master/Lib/zipfile.py#L1610

The documentation calls the parameter 'bytes', but the real parameter name is 'data'.

Looks like this was not fixed when the source changed to Python 3:
https://github.com/python/cpython/blob/2.7/Lib/zipfile.py#L1208

----------
assignee: docs at python
components: Documentation
messages: 268490
nosy: John Hagen, docs at python
priority: normal
severity: normal
status: open
title: Incorrect documentation for zipfile.writestr()
versions: Python 3.4, Python 3.5, Python 3.6

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue27311>
_______________________________________


More information about the docs mailing list