diff options
| author | aiordache <anca.iordache@docker.com> | 2020-09-21 10:23:29 +0200 |
|---|---|---|
| committer | aiordache <anca.iordache@docker.com> | 2020-09-21 10:23:29 +0200 |
| commit | aed570098518cbc73dc1450b001520a0c5bf5046 (patch) | |
| tree | 98b0f719ad6a6e1debd7e4c39faa30197c31553e /docker/api | |
| parent | cec152db5f679bc61c2093959bd9109cb9abb169 (diff) | |
| download | docker-py-aed570098518cbc73dc1450b001520a0c5bf5046.tar.gz | |
update `pull` method docs
Signed-off-by: aiordache <anca.iordache@docker.com>
Diffstat (limited to 'docker/api')
| -rw-r--r-- | docker/api/image.py | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/docker/api/image.py b/docker/api/image.py index dcce0ac..4082bfb 100644 --- a/docker/api/image.py +++ b/docker/api/image.py @@ -349,7 +349,8 @@ class ImageApiMixin(object): Args: repository (str): The repository to pull - tag (str): The tag to pull + tag (str): The tag to pull. If ``tag`` is ``None`` or empty, it + is set to ``latest``. stream (bool): Stream the output as a generator. Make sure to consume the generator, otherwise pull might get cancelled. auth_config (dict): Override the credentials that are found in the @@ -358,7 +359,8 @@ class ImageApiMixin(object): decode (bool): Decode the JSON data from the server into dicts. Only applies with ``stream=True`` platform (str): Platform in the format ``os[/arch[/variant]]`` - all_tags (bool): Pull all image tags. + all_tags (bool): Pull all image tags, the ``tag`` parameter is + ignored. Returns: (generator or str): The output |