Document returned values of module pause

Adds missing documentation of the return values of
`pause`. Important to know how to retrieve user input.
This commit is contained in:
philsch 2017-02-23 17:30:09 +01:00 committed by Brian Coca
parent 21e29080ba
commit a3099b2294

View file

@ -61,3 +61,31 @@ EXAMPLES = '''
- pause:
prompt: "Make sure org.foo.FooOverload exception is not present"
'''
RETURN = '''
user_input:
description: User input from interactive console
returned: if no waiting time set
type: string
sample: Example user input
start:
description: Time when started pausing
returned: always
type: string
sample: 2017-02-23 14:35:07.298862
stop:
description: Time when ended pausing
returned: always
type: string
sample: 2017-02-23 14:35:09.552594
delta:
description: Time paused in seconds
returned: always
type: string
sample: 2
stdout:
description: Output of pause module
returned: always
type: string
sample: Paused for 0.04 minutes
'''