]> git.ipfire.org Git - thirdparty/Python/cpython.git/commit
Docs: Add bz2 usage examples (GH-13258)
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Mon, 13 May 2019 18:50:16 +0000 (11:50 -0700)
committerGitHub <noreply@github.com>
Mon, 13 May 2019 18:50:16 +0000 (11:50 -0700)
commitee9b5ce3903542a55e7f55817538d355bb260518
treef30882fc7ec451af8e3db334210a4f95309488b3
parent19464bcd97436cd8d5d9e32b70faf3e1e5f2a712
Docs: Add bz2 usage examples (GH-13258)

* Docs: Add bz2 usage examples

- Adds an "Examples of usage" section inspired by the one
  found in the gzip docs
- Corrects the descriptions for ``compresslevel`` and ``data``:
    - ``compresslevel`` must be an `int`, not any number.  For
      instance, passing a float will raise ``TypeError``
    - Notes that `data` must be bytes-like
(cherry picked from commit be6939fb02e65b56c45377940b339d150b124d05)

Co-authored-by: Brad <brad.solomon.1124@gmail.com>
Doc/library/bz2.rst