| commit | be6939fb02e65b56c45377940b339d150b124d05 | [log] [tgz] |
|---|---|---|
| author | Brad <brad.solomon.1124@gmail.com> | Mon May 13 14:09:49 2019 -0400 |
| committer | Gregory P. Smith <greg@krypto.org> | Mon May 13 11:09:49 2019 -0700 |
| tree | c55485561602d8a9a221e8f80238ac61caae0083 | |
| parent | 95da83d9bac698d420cc308e8699ef6e4fae2aca [diff] |
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