Add docstring to ImageManager.__init__ and fix docstring for ImageMan…

…ager.archive_image (#509) (#511) (cherry picked from commit ee9ddb9) Co-authored-by: iamjpotts <[email protected]>
ansible-collections · Nov 30, 2022 · bb7f899 · bb7f899
1 parent 6512400
commit bb7f899
Showing 1 changed file with 12 additions and 2 deletions.
diff --git 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: