Minor corrections to the zipfile documentation

[serhiy-storchaka]

BPO	16025
Nosy	@pitrou, @ezio-melotti, @asvetlov, @cjerdonek, @serhiy-storchaka
Files	doc_zipfile-3.3.patch: Patch for 3.3 and 3.4 doc_zipfile-3.2.patch doc_zipfile-2.7.patch

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = None
closed_at = <Date 2012-10-06.16:11:18.919>
created_at = <Date 2012-09-24.16:08:01.788>
labels = ['type-feature', 'docs']
title = 'Minor corrections to the zipfile documentation'
updated_at = <Date 2012-10-06.16:11:46.870>
user = 'https://github.com/serhiy-storchaka'

bugs.python.org fields:

activity = <Date 2012-10-06.16:11:46.870>
actor = 'serhiy.storchaka'
assignee = 'docs@python'
closed = True
closed_date = <Date 2012-10-06.16:11:18.919>
closer = 'serhiy.storchaka'
components = ['Documentation']
creation = <Date 2012-09-24.16:08:01.788>
creator = 'serhiy.storchaka'
dependencies = []
files = ['27298', '27299', '27300']
hgrepos = []
issue_num = 16025
keywords = ['patch', 'needs review']
message_count = 9.0
messages = ['171157', '171267', '171278', '171305', '172206', '172207', '172211', '172212', '172214']
nosy_count = 7.0
nosy_names = ['pitrou', 'ezio.melotti', 'asvetlov', 'chris.jerdonek', 'docs@python', 'python-dev', 'serhiy.storchaka']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue16025'
versions = ['Python 2.7', 'Python 3.2', 'Python 3.3', 'Python 3.4']

[serhiy-storchaka]

The proposed patch corrects a few markup errors in the zipfile documentation and adds a few relevant hyperlinks.

[cjerdonek]

• :meth:`close`\ d without adding any files to the archive, the appropriate
  + :meth:`close <close>`\ d without adding any files to the archive, the appropriate

This formatting looks odd to me when rendered (both cases). I would perhaps suggest something like, "... and then close() is called without ...."

[ezio-melotti]

:meth:`closed <close>` works too.

[serhiy-storchaka]

:meth:`closed <close>` works too.

Patches updated.

[python-dev]

New changeset 2c398a78dba8 by Andrew Svetlov in branch '2.7':
Issue bpo-16025: Minor corrections to the zipfile documentation.
http://hg.python.org/cpython/rev/2c398a78dba8

New changeset 3d54d17a637b by Andrew Svetlov in branch '3.2':
Issue bpo-16025: Minor corrections to the zipfile documentation.
http://hg.python.org/cpython/rev/3d54d17a637b

New changeset 2e7a57cdd961 by Andrew Svetlov in branch '3.3':
Issue bpo-16025: Minor corrections to the zipfile documentation.
http://hg.python.org/cpython/rev/2e7a57cdd961

New changeset 7fd068d4ded8 by Andrew Svetlov in branch 'default':
Issue bpo-16025: Minor corrections to the zipfile documentation.
http://hg.python.org/cpython/rev/7fd068d4ded8

[asvetlov]

Committed. Please close the issue if all work done.
Thanks.

[pitrou]

Andrew, please revert the test_subprocess changes.

[asvetlov]

Done in 674fa8d211f2, 5665806908c4 and c9695a0b0923. Sorry.

[serhiy-storchaka]

Thank you, Andrew.