From d15c5a869dd64362941d127a7216495ead0802f7 Mon Sep 17 00:00:00 2001 From: Nadeem Vawda Date: Sun, 5 Feb 2012 14:27:01 +0200 Subject: [PATCH] Clarify note in BZ2File docs about lack of multi-stream support (issue #1625). --- Doc/library/bz2.rst | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/Doc/library/bz2.rst b/Doc/library/bz2.rst index 3ff227b34a4..20dc765774d 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 `_ instead of this class. + support for multi-stream files, consider using the third-party + :mod:`bz2file` module (available from + `PyPI `_). This module provides a + backport of Python 3.3's :class:`BZ2File` class, which does support + multi-stream files. .. method:: close()