ansible-collections/community.docker
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.docker.git synced 2025-12-17 20:38:42 +00:00
Code Packages Projects Releases Wiki Activity

Add docstring to ImageManager.__init__ and fix docstring for ImageManager.archive_image (#509)

Browse Source
This commit is contained in:
iamjpotts 2022-11-30 15:04:11 -06:00 committed by GitHub
parent 90086f00ad
commit ee9ddb954f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
plugins/modules/docker_image.py
View File

@ -373,6 +373,14 @@ from ansible_collections.community.docker.plugins.module_utils._api.utils.utils
class ImageManager(DockerBaseClass): class ImageManager(DockerBaseClass):
def __init__(self, client, results): 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__() super(ImageManager, self).__init__()
@ -531,8 +539,10 @@ class ImageManager(DockerBaseClass):
''' '''
Archive an image to a .tar file. Called when archive_path is passed. Archive an image to a .tar file. Called when archive_path is passed.
:param name - name of the image. Type: str :param name: Name/repository of the image
:return None :type name: str
:param tag: Optional image tag; assumed to be "latest" if None
:type tag: str | None
''' '''
if not tag: if not tag: