cpython: ad20324229f4 (original) (raw)

Mercurial > cpython

changeset 74783:ad20324229f4 2.7

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

Nadeem Vawda nadeem.vawda@gmail.com
date	Sun, 05 Feb 2012 14:27:01 +0200
parents	7c263bfc92f5
children	2b93ee675ec4
files	Doc/library/bz2.rst
diffstat	1 files changed, 5 insertions(+), 2 deletions(-)[+] [-] Doc/library/bz2.rst 7

line wrap: on

line diff

--- a/Doc/library/bz2.rst +++ b/Doc/library/bz2.rst @@ -72,8 +72,11 @@ Handling of compressed files is offered 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[](#l1.7)

 module <http://pypi.python.org/pypi/bz2file>`_ instead of this class.[](#l1.8)

 support for multi-stream files, consider using the third-party[](#l1.9)

 :mod:`bz2file` module (available from[](#l1.10)

 `PyPI <http://pypi.python.org/pypi/bz2file>`_). This module provides a[](#l1.11)

 backport of Python 3.3's :class:`BZ2File` class, which does support[](#l1.12)

```
 multi-stream files.[](#l1.13)
```

.. method:: close()