[Python-checkins] cpython (3.2): Clarify note in BZ2File docs about lack of multi-stream support (issue #1625).

[nadeem.vawda]

http://hg.python.org/cpython/rev/e4c4595033ad
changeset:   74784:e4c4595033ad
branch:      3.2
parent:      74777:cd748bab3cdd
user:        Nadeem Vawda <nadeem.vawda at gmail.com>
date:        Sun Feb 05 14:29:00 2012 +0200
summary:
  Clarify note in BZ2File docs about lack of multi-stream support (issue #1625).

files:
  Doc/library/bz2.rst |  7 +++++--
  1 files changed, 5 insertions(+), 2 deletions(-)


diff --git a/Doc/library/bz2.rst b/Doc/library/bz2.rst
--- a/Doc/library/bz2.rst
+++ b/Doc/library/bz2.rst
@@ -70,8 +70,11 @@
       This class does not support input files containing multiple streams (such
       as those produced by the :program:`pbzip2` tool). When reading such an
       input file, only the first stream will be accessible. If you require
-      support for multi-stream files, consider using the third-party `bz2file
-      module <http://pypi.python.org/pypi/bz2file>`_ instead of this class.
+      support for multi-stream files, consider using the third-party
+      :mod:`bz2file` module (available from
+      `PyPI <http://pypi.python.org/pypi/bz2file>`_). This module provides a
+      backport of Python 3.3's :class:`BZ2File` class, which does support
+      multi-stream files.
 
 
    .. method:: close()

-- 
Repository URL: http://hg.python.org/cpython