Docs: Add bz2 usage examples (GH-13258)
authorBrad <brad.solomon.1124@gmail.com>
Mon, 13 May 2019 18:09:49 +0000 (14:09 -0400)
committerGregory P. Smith <greg@krypto.org>
Mon, 13 May 2019 18:09:49 +0000 (11:09 -0700)
commitbe6939fb02e65b56c45377940b339d150b124d05
treec55485561602d8a9a221e8f80238ac61caae0083
parent95da83d9bac698d420cc308e8699ef6e4fae2aca
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
Doc/library/bz2.rst