mirror of
https://github.com/ansible-collections/community.docker.git
synced 2026-07-29 11:55:04 +00:00
Reformat documentation with 'andebox yaml-doc' (#1020)
* Reformat documentation with 'andebox yaml-doc'. * Revert unwanted changes. * Fix too long lines. * Fix broken quotes. * Forgot two line breaks.
This commit is contained in:
@@ -8,8 +8,7 @@ from __future__ import absolute_import, division, print_function
|
||||
__metaclass__ = type
|
||||
|
||||
|
||||
DOCUMENTATION = '''
|
||||
---
|
||||
DOCUMENTATION = r"""
|
||||
module: docker_image_remove
|
||||
|
||||
short_description: Remove Docker images
|
||||
@@ -18,7 +17,6 @@ version_added: 3.6.0
|
||||
|
||||
description:
|
||||
- Remove Docker images from the Docker daemon.
|
||||
|
||||
extends_documentation_fragment:
|
||||
- community.docker.docker.api_documentation
|
||||
- community.docker.attributes
|
||||
@@ -33,8 +31,8 @@ attributes:
|
||||
options:
|
||||
name:
|
||||
description:
|
||||
- "Image name. Name format will be one of: C(name), C(repository/name), C(registry_server:port/name).
|
||||
When pushing or pulling an image the name can optionally include the tag by appending C(:tag_name)."
|
||||
- 'Image name. Name format will be one of: C(name), C(repository/name), C(registry_server:port/name). When pushing or
|
||||
pulling an image the name can optionally include the tag by appending C(:tag_name).'
|
||||
- Note that image IDs (hashes) can also be used.
|
||||
type: str
|
||||
required: true
|
||||
@@ -65,38 +63,37 @@ seealso:
|
||||
- module: community.docker.docker_image_load
|
||||
- module: community.docker.docker_image_pull
|
||||
- module: community.docker.docker_image_tag
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
"""
|
||||
|
||||
EXAMPLES = r"""
|
||||
- name: Remove an image
|
||||
community.docker.docker_image_remove:
|
||||
name: pacur/centos-7
|
||||
'''
|
||||
"""
|
||||
|
||||
RETURN = '''
|
||||
RETURN = r"""
|
||||
image:
|
||||
description:
|
||||
- Image inspection results for the affected image before removal.
|
||||
- Empty if the image was not found.
|
||||
returned: success
|
||||
type: dict
|
||||
sample: {}
|
||||
description:
|
||||
- Image inspection results for the affected image before removal.
|
||||
- Empty if the image was not found.
|
||||
returned: success
|
||||
type: dict
|
||||
sample: {}
|
||||
deleted:
|
||||
description:
|
||||
- The digests of the images that were deleted.
|
||||
returned: success
|
||||
type: list
|
||||
elements: str
|
||||
sample: []
|
||||
description:
|
||||
- The digests of the images that were deleted.
|
||||
returned: success
|
||||
type: list
|
||||
elements: str
|
||||
sample: []
|
||||
untagged:
|
||||
description:
|
||||
- The digests of the images that were untagged.
|
||||
returned: success
|
||||
type: list
|
||||
elements: str
|
||||
sample: []
|
||||
'''
|
||||
description:
|
||||
- The digests of the images that were untagged.
|
||||
returned: success
|
||||
type: list
|
||||
elements: str
|
||||
sample: []
|
||||
"""
|
||||
|
||||
import traceback
|
||||
|
||||
|
||||
Reference in New Issue
Block a user