[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/inventory/iocage.py

@@ -8,29 +8,25 @@ from __future__ import annotations
 
 DOCUMENTATION = r"""
 name: iocage
-short_description: iocage inventory source
+short_description: C(iocage) inventory source
 version_added: 10.2.0
 author:
   - Vladimir Botka (@vbotka)
 requirements:
   - iocage >= 1.8
 description:
-  - Get inventory hosts from the iocage jail manager running on O(host).
-  - By default, O(host) is V(localhost). If O(host) is not V(localhost) it
-    is expected that the user running Ansible on the controller can
-    connect to the O(host) account O(user) with SSH non-interactively and
-    execute the command C(iocage list).
-  - Uses a configuration file as an inventory source, it must end
-    in C(.iocage.yml) or C(.iocage.yaml).
+  - Get inventory hosts from the C(iocage) jail manager running on O(host).
+  - By default, O(host) is V(localhost). If O(host) is not V(localhost) it is expected that the user running Ansible on the
+    controller can connect to the O(host) account O(user) with SSH non-interactively and execute the command C(iocage list).
+  - Uses a configuration file as an inventory source, it must end in C(.iocage.yml) or C(.iocage.yaml).
 extends_documentation_fragment:
   - ansible.builtin.constructed
   - ansible.builtin.inventory_cache
 options:
   plugin:
     description:
-      - The name of this plugin, it should always be set to
-        V(community.general.iocage) for this plugin to recognize
-        it as its own.
+      - The name of this plugin, it should always be set to V(community.general.iocage) for this plugin to recognize it as
+        its own.
     required: true
     choices: ['community.general.iocage']
     type: str
@@ -40,10 +36,8 @@ options:
     default: localhost
   user:
     description:
-      - C(iocage) user.
-        It is expected that the O(user) is able to connect to the
-        O(host) with SSH and execute the command C(iocage list).
-        This option is not required if O(host) is V(localhost).
+      - C(iocage) user. It is expected that the O(user) is able to connect to the O(host) with SSH and execute the command
+        C(iocage list). This option is not required if O(host=localhost).
     type: str
   sudo:
     description:
@@ -61,8 +55,7 @@ options:
     version_added: 10.3.0
   get_properties:
     description:
-      - Get jails' properties.
-        Creates dictionary C(iocage_properties) for each added host.
+      - Get jails' properties. Creates dictionary C(iocage_properties) for each added host.
     type: bool
     default: false
   env:
@@ -84,7 +77,7 @@ options:
     description:
       - The name of the tag in the C(iocage properties notes) that contains the jails alias.
       - By default, the C(iocage list -l) column C(NAME) is used to name the jail.
-      - This option requires the notes format C("t1=v1 t2=v2 ...")
+      - This option requires the notes format C("t1=v1 t2=v2 ...").
       - The option O(get_properties) must be enabled.
     type: str
     version_added: 11.0.0
@@ -95,21 +88,16 @@ options:
     default: false
     version_added: 11.0.0
 notes:
-  - You might want to test the command C(ssh user@host iocage list -l) on
-    the controller before using this inventory plugin with O(user) specified
-    and with O(host) other than V(localhost).
-  - If you run this inventory plugin on V(localhost) C(ssh) is not used.
-    In this case, test the command C(iocage list -l).
+  - You might want to test the command C(ssh user@host iocage list -l) on the controller before using this inventory plugin
+    with O(user) specified and with O(host) other than V(localhost).
+  - If you run this inventory plugin on V(localhost) C(ssh) is not used. In this case, test the command C(iocage list -l).
   - This inventory plugin creates variables C(iocage_*) for each added host.
-  - The values of these variables are collected from the output of the
-    command C(iocage list -l).
+  - The values of these variables are collected from the output of the command C(iocage list -l).
   - The names of these variables correspond to the output columns.
   - The column C(NAME) is used to name the added host.
-  - The option O(hooks_results) expects the C(poolname) of a jail is mounted to
-    C(/poolname). For example, if you activate the pool C(iocage) this plugin
-    expects to find the O(hooks_results) items in the path
-    C(/iocage/iocage/jails/<name>/root). If you mount the C(poolname) to a
-    different path the easiest remedy is to create a symlink.
+  - The option O(hooks_results) expects the C(poolname) of a jail is mounted to C(/poolname). For example, if you activate
+    the pool C(iocage) this plugin expects to find the O(hooks_results) items in the path C(/iocage/iocage/jails/<name>/root).
+    If you mount the C(poolname) to a different path the easiest remedy is to create a symlink.
 """
 
 EXAMPLES = r"""