diff options
| author | Joffrey F <f.joffrey@gmail.com> | 2018-09-14 16:40:58 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2018-09-14 16:40:58 -0700 |
| commit | 02316eaf25637c972e08086ae739931032f51bf1 (patch) | |
| tree | a54b155370665eb376b5f05aa839019cb8e3669a | |
| parent | e78e4e7491da7055151bfe454282770786a8c270 (diff) | |
| parent | 74a293a9c92e30ff8e7927694a147ca293fbf686 (diff) | |
| download | docker-py-02316eaf25637c972e08086ae739931032f51bf1.tar.gz | |
Merge pull request #2129 from adw1n/i2122-docs
Fix docs for `chunk_size` parameter
| -rw-r--r-- | docker/models/images.py | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/docker/models/images.py b/docker/models/images.py index 41632c6..7d9ab70 100644 --- a/docker/models/images.py +++ b/docker/models/images.py @@ -64,9 +64,9 @@ class Image(Model): Get a tarball of an image. Similar to the ``docker save`` command. Args: - chunk_size (int): The number of bytes returned by each iteration - of the generator. If ``None``, data will be streamed as it is - received. Default: 2 MB + chunk_size (int): The generator will return up to that much data + per iteration, but may return less. If ``None``, data will be + streamed as it is received. Default: 2 MB Returns: (generator): A stream of raw archive data. |