Fix docs. (#436)

This commit is contained in:
Felix Fontein 2022-08-04 14:23:52 +02:00 committed by GitHub
parent b2bb064e47
commit bc6757d3b8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 14 additions and 13 deletions

View File

@ -67,7 +67,7 @@ network:
- Will be C(none) if network does not exist. - Will be C(none) if network does not exist.
returned: always returned: always
type: dict type: dict
sample: '{ sample: {
"Attachable": false, "Attachable": false,
"ConfigFrom": { "ConfigFrom": {
"Network": "" "Network": ""
@ -94,7 +94,7 @@ network:
"Name": "ansible-test-f2700bba", "Name": "ansible-test-f2700bba",
"Options": {}, "Options": {},
"Scope": "local" "Scope": "local"
}' }
''' '''
import traceback import traceback

View File

@ -118,13 +118,13 @@ containers:
returned: I(containers) is C(true) returned: I(containers) is C(true)
type: list type: list
elements: str elements: str
sample: '[]' sample: []
containers_space_reclaimed: containers_space_reclaimed:
description: description:
- Amount of reclaimed disk space from container pruning in bytes. - Amount of reclaimed disk space from container pruning in bytes.
returned: I(containers) is C(true) returned: I(containers) is C(true)
type: int type: int
sample: '0' sample: 0
# images # images
images: images:
@ -133,13 +133,13 @@ images:
returned: I(images) is C(true) returned: I(images) is C(true)
type: list type: list
elements: str elements: str
sample: '[]' sample: []
images_space_reclaimed: images_space_reclaimed:
description: description:
- Amount of reclaimed disk space from image pruning in bytes. - Amount of reclaimed disk space from image pruning in bytes.
returned: I(images) is C(true) returned: I(images) is C(true)
type: int type: int
sample: '0' sample: 0
# networks # networks
networks: networks:
@ -148,7 +148,7 @@ networks:
returned: I(networks) is C(true) returned: I(networks) is C(true)
type: list type: list
elements: str elements: str
sample: '[]' sample: []
# volumes # volumes
volumes: volumes:
@ -157,13 +157,13 @@ volumes:
returned: I(volumes) is C(true) returned: I(volumes) is C(true)
type: list type: list
elements: str elements: str
sample: '[]' sample: []
volumes_space_reclaimed: volumes_space_reclaimed:
description: description:
- Amount of reclaimed disk space from volumes pruning in bytes. - Amount of reclaimed disk space from volumes pruning in bytes.
returned: I(volumes) is C(true) returned: I(volumes) is C(true)
type: int type: int
sample: '0' sample: 0
# builder_cache # builder_cache
builder_cache_space_reclaimed: builder_cache_space_reclaimed:
@ -171,7 +171,7 @@ builder_cache_space_reclaimed:
- Amount of reclaimed disk space from builder cache pruning in bytes. - Amount of reclaimed disk space from builder cache pruning in bytes.
returned: I(builder_cache) is C(true) returned: I(builder_cache) is C(true)
type: int type: int
sample: '0' sample: 0
''' '''
import traceback import traceback

View File

@ -24,10 +24,11 @@ results:
description: | description: |
List of dictionaries containing the list of stacks or tasks associated List of dictionaries containing the list of stacks or tasks associated
to a stack name. to a stack name.
sample: > sample:
"results": [{"name":"grafana","namespace":"default","orchestrator":"Kubernetes","services":"2"}] - {"name":"grafana","namespace":"default","orchestrator":"Kubernetes","services":"2"}
returned: always returned: always
type: list type: list
elements: dict
''' '''
EXAMPLES = ''' EXAMPLES = '''

View File

@ -277,7 +277,7 @@ actions:
returned: when action failed. returned: when action failed.
type: list type: list
elements: str elements: str
example: "['This cluster is already a swarm cluster']" example: ['This cluster is already a swarm cluster']
''' '''