From: Nadeem Vawda <nadeem.vawda@gmail.com>
Date: Sun, 5 Feb 2012 12:27:01 +0000 (+0200)
Subject: Clarify note in BZ2File docs about lack of multi-stream support (issue #1625).
X-Git-Tag: v2.7.3rc1~88
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=d15c5a869dd64362941d127a7216495ead0802f7;p=thirdparty%2FPython%2Fcpython.git

Clarify note in BZ2File docs about lack of multi-stream support (issue #1625).
---

diff --git a/Doc/library/bz2.rst b/Doc/library/bz2.rst
index 3ff227b34a40..20dc765774d5 100644
--- a/Doc/library/bz2.rst
+++ b/Doc/library/bz2.rst
@@ -72,8 +72,11 @@ Handling of compressed files is offered by the :class:`BZ2File` class.
       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()