summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authoradw1n <adw1n@users.noreply.github.com>2018-09-03 02:49:16 +0200
committeradw1n <adw1n@users.noreply.github.com>2018-09-03 03:12:33 +0200
commit74a293a9c92e30ff8e7927694a147ca293fbf686 (patch)
treea54b155370665eb376b5f05aa839019cb8e3669a
parente78e4e7491da7055151bfe454282770786a8c270 (diff)
downloaddocker-py-74a293a9c92e30ff8e7927694a147ca293fbf686.tar.gz
Fix docs for `chunk_size` parameter
Closes #2122 Signed-off-by: Przemysław Adamek <adw1n@users.noreply.github.com>
-rw-r--r--docker/models/images.py6
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.