[issue27311] Incorrect documentation for zipfile.writestr()

[Martin Panter]

Changes by Martin Panter :


--
resolution:  -> fixed
stage: commit review -> resolved
status: open -> closed

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue27311] Incorrect documentation for zipfile.writestr()

[Roundup Robot]

Roundup Robot added the comment:

New changeset 32af78a8b88f by Martin Panter in branch '3.5':
Issue #27311: Fix ZipFile.writestr data argument name.
https://hg.python.org/cpython/rev/32af78a8b88f

New changeset e3bb87952c62 by Martin Panter in branch 'default':
Issue #27311: Merge zipfile doc from 3.5
https://hg.python.org/cpython/rev/e3bb87952c62

--
nosy: +python-dev

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue27311] Incorrect documentation for zipfile.writestr()

[Martin Panter]

Martin Panter added the comment:

Thanks John

--
stage: needs patch -> commit review

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue27311] Incorrect documentation for zipfile.writestr()

[John Hagen]

John Hagen added the comment:

Patch attached.

--
keywords: +patch
Added file: 
http://bugs.python.org/file43395/0001-Fix-ZipFile.writestr-data-argument-name.patch

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue27311] Incorrect documentation for zipfile.writestr()

[John Hagen]

John Hagen added the comment:

I'll submit a patch shortly.

--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue27311] Incorrect documentation for zipfile.writestr()

[Martin Panter]

Martin Panter added the comment:

Looks like you are right. The change in the implementation happened in revision 
19196cce1431.

--
keywords: +easy
nosy: +martin.panter
stage:  -> needs patch
versions:  -Python 3.4

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue27311] Incorrect documentation for zipfile.writestr()

[John Hagen]

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@python
components: Documentation
messages: 268490
nosy: John Hagen, docs@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 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com