From ee9ddb954f4416222657968aea3d93495b3bf55f Mon Sep 17 00:00:00 2001 From: iamjpotts <8704475+iamjpotts@users.noreply.github.com> Date: Wed, 30 Nov 2022 15:04:11 -0600 Subject: [PATCH] Add docstring to ImageManager.__init__ and fix docstring for ImageManager.archive_image (#509) --- 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 24713c1d..7d91b64a 100644 --- a/plugins/modules/docker_image.py +++ b/plugins/modules/docker_image.py @@ -373,6 +373,14 @@ from ansible_collections.community.docker.plugins.module_utils._api.utils.utils 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__() @@ -531,8 +539,10 @@ class ImageManager(DockerBaseClass): ''' 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: