Update the module with the correct examples and descriptions (#648)

* Update the module with the correct examples and descriptions

Signed-off-by: ddimatos <[email protected]>

* Add changelog fragment

Signed-off-by: ddimatos <[email protected]>

---------

Signed-off-by: ddimatos <[email protected]>

Author: ddimatos

changelogs/fragments/648-zos_operator-examples.yml

@@ -0,0 +1,4 @@
+bugfixes:
+ - zos_operator - fixed incorrect example descriptions and updated the doc to
+   highlight the deprecated option `wait`.
+   (https://github.com/ansible-collections/ibm_zos_core/pull/648)

plugins/modules/zos_operator.py

@@ -57,22 +57,24 @@
     default: 1
   wait:
     description:
-      - Configuring wait used by the L(zos_operator,./zos_operator.html) module has been
-        deprecated and will be removed in ibm.ibm_zos_core collection.
+      - Configuring wait used by the L(zos_operator,./zos_operator.html) module
+        has been deprecated and will be removed in a future ibm.ibm_zos_core
+        collection.
       - Setting this option will yield no change, it is deprecated.
+      - Review option I(wait_time_s) to instruct operator commands to wait.
     type: bool
     required: false
     default: true
 """
 
 EXAMPLES = r"""
-- name: Execute an operator command to show active jobs
+- name: Execute an operator command to show device status and allocation
   zos_operator:
-    cmd: 'd u,all'
+    cmd: 'd u'
 
-- name: Execute an operator command to show active jobs with verbose information
+- name: Execute an operator command to show device status and allocation with verbose information
   zos_operator:
-    cmd: 'd u,all'
+    cmd: 'd u'
     verbose: true
 
 - name: Execute an operator command to purge all job logs (requires escaping)
@@ -81,12 +83,12 @@
 
 - name: Execute operator command to show jobs, waiting up to 5 seconds for response
   zos_operator:
-    cmd: 'd u,all'
+    cmd: 'd a,all'
     wait_time_s: 5
 
 - name: Execute operator command to show jobs, always waiting 7 seconds for response
   zos_operator:
-    cmd: 'd u,all'
+    cmd: 'd a,all'
     wait_time_s: 7
 """