Merging upstream version 2.16.5.

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

1 files changed, 3 insertions, 1 deletions

diff --git a/lib/ansible/modules/pause.py b/lib/ansible/modules/pause.py
index 09061dd..450bfaf 100644
--- a/lib/ansible/modules/pause.py
+++ b/lib/ansible/modules/pause.py
@@ -15,6 +15,7 @@ description:
   - To pause/wait/sleep per host, use the M(ansible.builtin.wait_for) module.
   - You can use C(ctrl+c) if you wish to advance a pause earlier than it is set to expire or if you need to abort a playbook run entirely.
     To continue early press C(ctrl+c) and then C(c). To abort a playbook press C(ctrl+c) and then C(a).
+  - Prompting for a set amount of time is not supported. Pausing playbook execution is interruptable but does not return user input.
   - The pause module integrates into async/parallelized playbooks without any special considerations (see Rolling Updates).
     When using pauses with the C(serial) playbook parameter (as in rolling updates) you are only prompted once for the current group of hosts.
   - This module is also supported for Windows targets.
@@ -29,10 +30,11 @@ options:
   prompt:
     description:
       - Optional text to use for the prompt message.
+      - User input is only returned if O(seconds=None) and O(minutes=None), otherwise this is just a custom message before playbook execution is paused.
   echo:
     description:
       - Controls whether or not keyboard input is shown when typing.
-      - Has no effect if 'seconds' or 'minutes' is set.
+      - Only has effect if O(seconds=None) and O(minutes=None).
     type: bool
     default: 'yes'
     version_added: 2.5