[issue16025] Minor corrections to the zipfile documentation

New submission from Serhiy Storchaka: The proposed patch corrects a few markup errors in the zipfile documentation and adds a few relevant hyperlinks. ---------- assignee: docs@python components: Documentation files: doc_zipfile-3.3.patch keywords: patch messages: 171157 nosy: docs@python, storchaka priority: normal severity: normal status: open title: Minor corrections to the zipfile documentation versions: Python 2.7, Python 3.2, Python 3.3 Added file: http://bugs.python.org/file27277/doc_zipfile-3.3.patch _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue16025> _______________________________________

Changes by Serhiy Storchaka <storchaka@gmail.com>: Added file: http://bugs.python.org/file27278/doc_zipfile-3.2.patch _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue16025> _______________________________________

Changes by Serhiy Storchaka <storchaka@gmail.com>: Added file: http://bugs.python.org/file27279/doc_zipfile-2.7.patch _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue16025> _______________________________________

Changes by Ezio Melotti <ezio.melotti@gmail.com>: ---------- nosy: +ezio.melotti stage: -> patch review type: -> enhancement _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue16025> _______________________________________

Chris Jerdonek added the comment: - :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 ...." ---------- nosy: +chris.jerdonek _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue16025> _______________________________________

Ezio Melotti added the comment: :meth:`closed <close>` works too. ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue16025> _______________________________________

Serhiy Storchaka added the comment:
:meth:`closed <close>` works too.
Patches updated. ---------- Added file: http://bugs.python.org/file27298/doc_zipfile-3.3.patch Added file: http://bugs.python.org/file27299/doc_zipfile-3.2.patch Added file: http://bugs.python.org/file27300/doc_zipfile-2.7.patch _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue16025> _______________________________________

Changes by Serhiy Storchaka <storchaka@gmail.com>: Removed file: http://bugs.python.org/file27277/doc_zipfile-3.3.patch _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue16025> _______________________________________

Changes by Serhiy Storchaka <storchaka@gmail.com>: Removed file: http://bugs.python.org/file27278/doc_zipfile-3.2.patch _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue16025> _______________________________________

Changes by Serhiy Storchaka <storchaka@gmail.com>: Removed file: http://bugs.python.org/file27279/doc_zipfile-2.7.patch _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue16025> _______________________________________

Changes by Serhiy Storchaka <storchaka@gmail.com>: ---------- keywords: +needs review versions: +Python 3.4 _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue16025> _______________________________________

Roundup Robot added the comment: New changeset 2c398a78dba8 by Andrew Svetlov in branch '2.7': Issue #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 #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 #16025: Minor corrections to the zipfile documentation. http://hg.python.org/cpython/rev/2e7a57cdd961 New changeset 7fd068d4ded8 by Andrew Svetlov in branch 'default': Issue #16025: Minor corrections to the zipfile documentation. http://hg.python.org/cpython/rev/7fd068d4ded8 ---------- nosy: +python-dev _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue16025> _______________________________________

Andrew Svetlov added the comment: Committed. Please close the issue if all work done. Thanks. ---------- nosy: +asvetlov _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue16025> _______________________________________

Antoine Pitrou added the comment: Andrew, please revert the test_subprocess changes. ---------- nosy: +pitrou _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue16025> _______________________________________

Andrew Svetlov added the comment: Done in 674fa8d211f2, 5665806908c4 and c9695a0b0923. Sorry. ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue16025> _______________________________________

Serhiy Storchaka added the comment: Thank you, Andrew. ---------- resolution: -> fixed status: open -> closed _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue16025> _______________________________________

Changes by Serhiy Storchaka <storchaka@gmail.com>: ---------- stage: patch review -> committed/rejected _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue16025> _______________________________________

Changes by Serhiy Storchaka <storchaka@gmail.com>: Added file: http://bugs.python.org/file27278/doc_zipfile-3.2.patch _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue16025> _______________________________________

Changes by Serhiy Storchaka <storchaka@gmail.com>: Added file: http://bugs.python.org/file27279/doc_zipfile-2.7.patch _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue16025> _______________________________________

Changes by Ezio Melotti <ezio.melotti@gmail.com>: ---------- nosy: +ezio.melotti stage: -> patch review type: -> enhancement _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue16025> _______________________________________

Chris Jerdonek added the comment: - :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 ...." ---------- nosy: +chris.jerdonek _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue16025> _______________________________________

Ezio Melotti added the comment: :meth:`closed <close>` works too. ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue16025> _______________________________________

Serhiy Storchaka added the comment:
:meth:`closed <close>` works too.
Patches updated. ---------- Added file: http://bugs.python.org/file27298/doc_zipfile-3.3.patch Added file: http://bugs.python.org/file27299/doc_zipfile-3.2.patch Added file: http://bugs.python.org/file27300/doc_zipfile-2.7.patch _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue16025> _______________________________________

Changes by Serhiy Storchaka <storchaka@gmail.com>: Removed file: http://bugs.python.org/file27277/doc_zipfile-3.3.patch _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue16025> _______________________________________

Changes by Serhiy Storchaka <storchaka@gmail.com>: Removed file: http://bugs.python.org/file27278/doc_zipfile-3.2.patch _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue16025> _______________________________________

Changes by Serhiy Storchaka <storchaka@gmail.com>: Removed file: http://bugs.python.org/file27279/doc_zipfile-2.7.patch _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue16025> _______________________________________

Changes by Serhiy Storchaka <storchaka@gmail.com>: ---------- keywords: +needs review versions: +Python 3.4 _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue16025> _______________________________________

Roundup Robot added the comment: New changeset 2c398a78dba8 by Andrew Svetlov in branch '2.7': Issue #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 #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 #16025: Minor corrections to the zipfile documentation. http://hg.python.org/cpython/rev/2e7a57cdd961 New changeset 7fd068d4ded8 by Andrew Svetlov in branch 'default': Issue #16025: Minor corrections to the zipfile documentation. http://hg.python.org/cpython/rev/7fd068d4ded8 ---------- nosy: +python-dev _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue16025> _______________________________________

Andrew Svetlov added the comment: Committed. Please close the issue if all work done. Thanks. ---------- nosy: +asvetlov _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue16025> _______________________________________

Antoine Pitrou added the comment: Andrew, please revert the test_subprocess changes. ---------- nosy: +pitrou _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue16025> _______________________________________

Andrew Svetlov added the comment: Done in 674fa8d211f2, 5665806908c4 and c9695a0b0923. Sorry. ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue16025> _______________________________________

Serhiy Storchaka added the comment: Thank you, Andrew. ---------- resolution: -> fixed status: open -> closed _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue16025> _______________________________________

Changes by Serhiy Storchaka <storchaka@gmail.com>: ---------- stage: patch review -> committed/rejected _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue16025> _______________________________________
participants (6)
-
Andrew Svetlov
-
Antoine Pitrou
-
Chris Jerdonek
-
Ezio Melotti
-
Roundup Robot
-
Serhiy Storchaka