From bb7f89974affd6eb471400955641fe234f8693b0 Mon Sep 17 00:00:00 2001 From: "patchback[bot]" <45432694+patchback[bot]@users.noreply.github.com> Date: Wed, 30 Nov 2022 22:14:34 +0100 Subject: [PATCH] Add docstring to ImageManager.__init__ and fix docstring for ImageManager.archive_image (#509) (#511) (cherry picked from commit ee9ddb954f4416222657968aea3d93495b3bf55f) Co-authored-by: iamjpotts <8704475+iamjpotts@users.noreply.github.com> --- plugins/modules/docker_image.py | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/plugins/modules/docker_image.py b/plugins/modules/docker_image.py index 92aa04e41..7769c811a 100644 --- a/plugins/modules/docker_image.py +++ b/plugins/modules/docker_image.py @@ -362,6 +362,14 @@ class ImageManager(DockerBaseClass): def __init__(self, client, results): + ''' + Configure a docker_image task. + + :param client: Ansible Docker Client wrapper over Docker client + :type client: AnsibleDockerClient + :param results: This task adds its output values to this dictionary + :type results: dict + ''' super(ImageManager, self).__init__() @@ -520,8 +528,10 @@ def archive_image(self, name, tag): ''' Archive an image to a .tar file. Called when archive_path is passed. - :param name - name of the image. Type: str - :return None + :param name: Name/repository of the image + :type name: str + :param tag: Optional image tag; assumed to be "latest" if None + :type tag: str | None ''' if not tag: