[issue16025] Minor corrections to the zipfile documentation

[Serhiy Storchaka]

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 

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

[issue16025] Minor corrections to the zipfile documentation

[Serhiy Storchaka]

Changes by Serhiy Storchaka :


Added file: http://bugs.python.org/file27278/doc_zipfile-3.2.patch

___
Python tracker 

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

[issue16025] Minor corrections to the zipfile documentation

[Serhiy Storchaka]

Changes by Serhiy Storchaka :


Added file: http://bugs.python.org/file27279/doc_zipfile-2.7.patch

___
Python tracker 

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

[issue16025] Minor corrections to the zipfile documentation

[Ezio Melotti]

Changes by Ezio Melotti :


--
nosy: +ezio.melotti
stage:  -> patch review
type:  -> enhancement

___
Python tracker 

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

[issue16025] Minor corrections to the zipfile documentation

[Chris Jerdonek]

Chris Jerdonek added the comment:

-   :meth:`close`\ d without adding any files to the archive, the appropriate
+   :meth:`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 

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

[issue16025] Minor corrections to the zipfile documentation

[Ezio Melotti]

Ezio Melotti added the comment:

:meth:`closed ` works too.

--

___
Python tracker 

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

[issue16025] Minor corrections to the zipfile documentation

[Serhiy Storchaka]

Changes by Serhiy Storchaka :


Removed file: http://bugs.python.org/file27277/doc_zipfile-3.3.patch

___
Python tracker 

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

[issue16025] Minor corrections to the zipfile documentation

[Serhiy Storchaka]

Changes by Serhiy Storchaka :


Removed file: http://bugs.python.org/file27278/doc_zipfile-3.2.patch

___
Python tracker 

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

[issue16025] Minor corrections to the zipfile documentation

[Serhiy Storchaka]

Changes by Serhiy Storchaka :


Removed file: http://bugs.python.org/file27279/doc_zipfile-2.7.patch

___
Python tracker 

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

[issue16025] Minor corrections to the zipfile documentation

[Serhiy Storchaka]

Serhiy Storchaka added the comment:

> :meth:`closed ` 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 

___diff -r 3d9c323711d0 Doc/library/zipfile.rst
--- a/Doc/library/zipfile.rst   Mon Sep 24 07:46:35 2012 +0200
+++ b/Doc/library/zipfile.rst   Mon Sep 24 18:56:25 2012 +0300
@@ -61,7 +61,7 @@
 .. class:: ZipInfo(filename='NoName', date_time=(1980,1,1,0,0,0))
 
Class used to represent information about a member of an archive. Instances
-   of this class are returned by the :meth:`getinfo` and :meth:`infolist`
+   of this class are returned by the :meth:`.getinfo` and :meth:`.infolist`
methods of :class:`ZipFile` objects.  Most users of the :mod:`zipfile` 
module
will not need to create these, but only use those created by this
module. *filename* should be the full name of the archive member, and
@@ -87,20 +87,20 @@
 .. data:: ZIP_DEFLATED
 
The numeric constant for the usual ZIP compression method.  This requires 
the
-   zlib module.
+   :mod:`zlib` module.
 
 
 .. data:: ZIP_BZIP2
 
The numeric constant for the BZIP2 compression method.  This requires the
-   bz2 module.
+   :mod:`bz2` module.
 
.. versionadded:: 3.3
 
 .. data:: ZIP_LZMA
 
The numeric constant for the LZMA compression method.  This requires the
-   lzma module.
+   :mod:`lzma` module.
 
.. versionadded:: 3.3
 
@@ -155,7 +155,7 @@
these extensions.
 
If the file is created with mode ``'a'`` or ``'w'`` and then
-   :meth:`close`\ d without adding any files to the archive, the appropriate
+   :meth:`closed ` without adding any files to the archive, the 
appropriate
ZIP structures for an empty archive will be written to the file.
 
ZipFile is also a context manager and therefore supports the
@@ -169,7 +169,7 @@
   Added the ability to use :class:`ZipFile` as a context manager.
 
.. versionchanged:: 3.3
-  Added support for :mod:`bzip2` and :mod:`lzma` compression.
+  Added support for :mod:`bzip2 ` and :mod:`lzma` compression.
 
 
 .. method:: ZipFile.close()
@@ -207,7 +207,7 @@
*mode* parameter, if included, must be one of the following: ``'r'`` (the
default), ``'U'``, or ``'rU'``. Choosing ``'U'`` or  ``'rU'`` will enable
:term:`universal newlines` support in the read-only object.  *pwd* is the
-   password used for encrypted files.  Calling  :meth:`open` on a closed
+   password used for encrypted files.  Calling  :meth:`.open` on a closed
ZipFile will raise a  :exc:`RuntimeError`.
 
.. note::
@@ -229,7 +229,7 @@
 
.. note::
 
-  The :meth:`open`, :meth:`read` and :meth:`extract` methods can take a 
filename
+  The :meth:`.open`, :meth:`read` and :meth:`extract` methods can take a 
filename
   or a :class:`ZipInfo` object.  You will appreciate this when trying to 
read a
   ZIP file that contains members with duplicate names.
 
@@ -335,7 +335,7 @@
   :class:`ZipInfo` constructor sets this member to :const:`ZIP_STORED`.
 
.. versionchanged:: 3.2
-  The *compression_type* argument.
+  The *compress_type* argument.
 
 The following data attributes are also available:
 
@@ -351,7 +351,7 @@
The comment text associated with the ZIP file.  If assigning a comment to a
:class:`ZipFile` instance created with mode 'a' or 'w', this should be a
string no longer than 65535 bytes.  Comments longer than this will be
-   truncated in the written archive when :meth:`ZipFile.close` is called.
+   truncated in the written archive when :meth:`close` is called.
 
 
 .. _pyzipfile-objects:
@@ -407,8 +407,8 @@
 ZipInfo Objects
 ---
 
-Instances of the :class:`ZipInfo` class are returned by the :meth:`getinfo` and
-:meth:`infolist` methods of :class:`ZipFile` objects.  Each object stores
+Instances of the :class:`ZipInfo` class are returned by the :meth:`.getinfo` 
and
+:meth:`.infolist` methods of :class:`ZipFile` objects.  Each object stores
 information about a single member of the ZIP archive.
 
 Instances have the following attributes:
diff -r aa73e60f65e9 Doc/library/zipfile.rst
--- a/Doc/library/zipfile.rst   Fri Sep 21 17:26:35 2012 +0300
+++ b/Doc/library/zipfile.rst   Mon Sep 24 19:01:40 2012 +0300
@@ -61,7 +61,7 @@
 .. class:: ZipInfo(filename='NoName', date_time=(1980,1,1,0,0,0))
 
Class used to represent information about a member of an archive. Instances
-   of this class are returned by the :meth:`getinfo` and :meth:`infolist`
+   of this class are returned by the :meth:`.getinfo` and :meth:`.infolist`
methods of :class:`ZipFile` objects.  Most users of the :mod:`zipfile` 
module
will not need to create these, but only use those created by this
module. *filename* shoul

[issue16025] Minor corrections to the zipfile documentation

[Serhiy Storchaka]

Changes by Serhiy Storchaka :


--
keywords: +needs review
versions: +Python 3.4

___
Python tracker 

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

[issue16025] Minor corrections to the zipfile documentation

[Roundup Robot]

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 

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

[issue16025] Minor corrections to the zipfile documentation

[Andrew Svetlov]

Andrew Svetlov added the comment:

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

--
nosy: +asvetlov

___
Python tracker 

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

[issue16025] Minor corrections to the zipfile documentation

[Antoine Pitrou]

Antoine Pitrou added the comment:

Andrew, please revert the test_subprocess changes.

--
nosy: +pitrou

___
Python tracker 

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

[issue16025] Minor corrections to the zipfile documentation

[Andrew Svetlov]

Andrew Svetlov added the comment:

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

--

___
Python tracker 

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

[issue16025] Minor corrections to the zipfile documentation

[Serhiy Storchaka]

Serhiy Storchaka added the comment:

Thank you, Andrew.

--
resolution:  -> fixed
status: open -> closed

___
Python tracker 

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

[issue16025] Minor corrections to the zipfile documentation

[Serhiy Storchaka]

Changes by Serhiy Storchaka :


--
stage: patch review -> committed/rejected

___
Python tracker 

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