diff options
| author | Nadeem Vawda <nadeem.vawda@gmail.com> | 2012-02-05 12:29:00 (GMT) |
|---|---|---|
| committer | Nadeem Vawda <nadeem.vawda@gmail.com> | 2012-02-05 12:29:00 (GMT) |
| commit | bd249c1bae9e70368ca190ca8e60b3e5343e9344 (patch) | |
| tree | f5cb3e32703c2552dfd0ef7ea9b5f48e03a4aa36 | |
| parent | 9701eb6e14e8a7d2bf2ae099611087c0a07baa43 (diff) | |
| download | cpython-bd249c1bae9e70368ca190ca8e60b3e5343e9344.zip cpython-bd249c1bae9e70368ca190ca8e60b3e5343e9344.tar.gz cpython-bd249c1bae9e70368ca190ca8e60b3e5343e9344.tar.bz2 | |
Clarify note in BZ2File docs about lack of multi-stream support (issue #1625).
| -rw-r--r-- | Doc/library/bz2.rst | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/Doc/library/bz2.rst b/Doc/library/bz2.rst index e493ddd..0a4804c 100644 --- a/Doc/library/bz2.rst +++ b/Doc/library/bz2.rst @@ -70,8 +70,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() |