[PR #10286/e37cd1a0 backport][stable-11] fix YAML docs in multiple plugins (#10293)

fix YAML docs in multiple plugins (#10286)

* fix YAML docs in multiple plugins

* pfexec: fix short description

* adjust callback plugins

* fix wsl connection

* fix filter plugins

* fix inventory plugins

* minor adjustments in diy, print_task, xen_orchestra

(cherry picked from commit e37cd1a015)

Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>

plugins/callback/context_demo.py

@@ -10,7 +10,7 @@ DOCUMENTATION = r"""
 author: Unknown (!UNKNOWN)
 name: context_demo
 type: aggregate
-short_description: demo callback that adds play/task context
+short_description: Demo callback that adds play/task context
 description:
   - Displays some play and task context along with normal output.
   - This is mostly for demo purposes.

plugins/callback/counter_enabled.py

@@ -12,7 +12,7 @@ DOCUMENTATION = r"""
 author: Unknown (!UNKNOWN)
 name: counter_enabled
 type: stdout
-short_description: adds counters to the output items (tasks and hosts/task)
+short_description: Adds counters to the output items (tasks and hosts/task)
 description:
   - Use this callback when you need a kind of progress bar on a large environments.
   - You will know how many tasks has the playbook to run, and which one is actually running.

plugins/callback/dense.py

@@ -9,7 +9,7 @@ from __future__ import annotations
 DOCUMENTATION = r"""
 name: dense
 type: stdout
-short_description: minimal stdout output
+short_description: Minimal stdout output
 extends_documentation_fragment:
   - default_callback
 description:

plugins/callback/diy.py

@@ -26,12 +26,12 @@ notes:
     callback. Additionally, C(ansible_callback_diy.top_level_var_names) will output the top level variable names available
     to the callback.
   - Each option value is rendered as a template before being evaluated. This allows for the dynamic usage of an option. For
-    example, C("{{ 'yellow' if ansible_callback_diy.result.is_changed else 'bright green' }}").
-  - 'B(Condition) for all C(msg) options: if value C(is None or omit), then the option is not being used. B(Effect): use
-    of the C(default) callback plugin for output.'
-  - 'B(Condition) for all C(msg) options: if value C(is not None and not omit and length is not greater than 0), then the
+    example, V("{{ 'yellow' if ansible_callback_diy.result.is_changed else 'bright green' }}").
+  - 'B(Condition) for all C(msg) options: if value V(is None or omit), then the option is not being used. B(Effect): use of
+    the C(default) callback plugin for output.'
+  - 'B(Condition) for all C(msg) options: if value V(is not None and not omit and length is not greater than 0), then the
     option is being used without output. B(Effect): suppress output.'
-  - 'B(Condition) for all C(msg) options: if value C(is not None and not omit and length is greater than 0), then the option
+  - 'B(Condition) for all C(msg) options: if value V(is not None and not omit and length is greater than 0), then the option
     is being used with output. B(Effect): render value as template and output.'
   - 'Valid color values: V(black), V(bright gray), V(blue), V(white), V(green), V(bright blue), V(cyan), V(bright green),
     V(red), V(bright cyan), V(purple), V(bright red), V(yellow), V(bright purple), V(dark gray), V(bright yellow), V(magenta),

plugins/callback/jabber.py

@@ -10,7 +10,7 @@ DOCUMENTATION = r"""
 author: Unknown (!UNKNOWN)
 name: jabber
 type: notification
-short_description: post task events to a Jabber server
+short_description: Post task events to a Jabber server
 description:
   - The chatty part of ChatOps with a Hipchat server as a target.
   - This callback plugin sends status updates to a HipChat channel during playbook execution.

plugins/callback/log_plays.py

@@ -10,7 +10,7 @@ DOCUMENTATION = r"""
 author: Unknown (!UNKNOWN)
 name: log_plays
 type: notification
-short_description: write playbook output to log file
+short_description: Write playbook output to log file
 description:
   - This callback writes playbook output to a file per host in the C(/var/log/ansible/hosts) directory.
 requirements:

plugins/callback/null.py

@@ -12,7 +12,7 @@ name: 'null'
 type: stdout
 requirements:
   - set as main display callback
-short_description: do not display stuff to screen
+short_description: Do not display stuff to screen
 description:
   - This callback prevents outputting events to screen.
 """

plugins/callback/print_task.py

@@ -6,7 +6,7 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = r'''
+DOCUMENTATION = r"""
 name: print_task
 type: aggregate
 short_description: Prints playbook task snippet to job output
@@ -15,14 +15,14 @@ description:
 version_added: 10.7.0
 requirements:
   - enable in configuration
-'''
+"""
 
-EXAMPLES = r'''
-ansible.cfg: >
-    # Enable plugin
-    [defaults]
-    callbacks_enabled=community.general.print_task
-'''
+EXAMPLES = r"""
+ansible.cfg: |-
+  # Enable plugin
+  [defaults]
+  callbacks_enabled=community.general.print_task
+"""
 
 from yaml import load, dump
 

plugins/callback/say.py

@@ -14,7 +14,7 @@ type: notification
 requirements:
   - whitelisting in configuration
   - the C(/usr/bin/say) command line program (standard on macOS) or C(espeak) command line program
-short_description: notify using software speech synthesizer
+short_description: Notify using software speech synthesizer
 description:
   - This plugin will use the C(say) or C(espeak) program to "speak" about play events.
 """

plugins/callback/selective.py

@@ -12,7 +12,7 @@ name: selective
 type: stdout
 requirements:
   - set as main display callback
-short_description: only print certain tasks
+short_description: Only print certain tasks
 description:
   - This callback only prints tasks that have been tagged with C(print_action) or that have failed. This allows operators
     to focus on the tasks that provide value only.

plugins/callback/syslog_json.py

@@ -12,7 +12,7 @@ name: syslog_json
 type: notification
 requirements:
   - whitelist in configuration
-short_description: sends JSON events to syslog
+short_description: Sends JSON events to syslog
 description:
   - This plugin logs ansible-playbook and ansible runs to a syslog server in JSON format.
 options:

plugins/callback/unixy.py

@@ -11,7 +11,7 @@ DOCUMENTATION = r"""
 name: unixy
 type: stdout
 author: Al Bowles (@akatch)
-short_description: condensed Ansible output
+short_description: Condensed Ansible output
 description:
   - Consolidated Ansible output in the style of LINUX/UNIX startup logs.
 extends_documentation_fragment: