Release 9.5.3.

fix typo (#9498)

(cherry picked from commit 7f3fef3038)

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

.azure-pipelines/azure-pipelines.yml

@@ -345,7 +345,7 @@ stages:
             - name: Debian Bookworm
               test: debian-bookworm/3.11
             - name: ArchLinux
-              test: archlinux/3.12
+              test: archlinux/3.13
           groups:
             - 1
             - 2

.github/BOTMETA.yml

@@ -1556,6 +1556,6 @@ macros:
   team_rhsm: cnsnyder ptoscano
   team_scaleway: remyleone abarbare
   team_solaris: bcoca fishman jasperla jpdasma mator scathatheworm troy2914 xen0l
-  team_suse: commel evrardjp lrupp toabctl AnderEnder alxgu andytom sealor
+  team_suse: commel evrardjp lrupp AnderEnder alxgu andytom sealor
   team_virt: joshainglis karmab Thulium-Drake Ajpantuso
   team_wdc: mikemoerk

.github/workflows/codeql-analysis.yml

@@ -25,6 +25,8 @@ jobs:
     steps:
     - name: Checkout repository
       uses: actions/checkout@v4
+      with:
+        persist-credentials: false
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL

.github/workflows/reuse.yml

@@ -28,6 +28,7 @@ jobs:
     steps:
       - uses: actions/checkout@v4
         with:
+          persist-credentials: false
           ref: ${{ github.event.pull_request.head.sha || '' }}
 
       - name: REUSE Compliance Check

CHANGELOG.md

@@ -2,59 +2,64 @@
 
 **Topics**
 
-- <a href="#v9-5-2">v9\.5\.2</a>
+- <a href="#v9-5-3">v9\.5\.3</a>
     - <a href="#release-summary">Release Summary</a>
     - <a href="#minor-changes">Minor Changes</a>
+    - <a href="#security-fixes">Security Fixes</a>
     - <a href="#bugfixes">Bugfixes</a>
-- <a href="#v9-5-1">v9\.5\.1</a>
+- <a href="#v9-5-2">v9\.5\.2</a>
     - <a href="#release-summary-1">Release Summary</a>
     - <a href="#minor-changes-1">Minor Changes</a>
     - <a href="#bugfixes-1">Bugfixes</a>
-- <a href="#v9-5-0">v9\.5\.0</a>
+- <a href="#v9-5-1">v9\.5\.1</a>
     - <a href="#release-summary-2">Release Summary</a>
     - <a href="#minor-changes-2">Minor Changes</a>
-    - <a href="#deprecated-features">Deprecated Features</a>
     - <a href="#bugfixes-2">Bugfixes</a>
-    - <a href="#new-modules">New Modules</a>
-- <a href="#v9-4-0">v9\.4\.0</a>
+- <a href="#v9-5-0">v9\.5\.0</a>
     - <a href="#release-summary-3">Release Summary</a>
     - <a href="#minor-changes-3">Minor Changes</a>
-    - <a href="#deprecated-features-1">Deprecated Features</a>
+    - <a href="#deprecated-features">Deprecated Features</a>
     - <a href="#bugfixes-3">Bugfixes</a>
-    - <a href="#new-modules-1">New Modules</a>
-- <a href="#v9-3-0">v9\.3\.0</a>
+    - <a href="#new-modules">New Modules</a>
+- <a href="#v9-4-0">v9\.4\.0</a>
     - <a href="#release-summary-4">Release Summary</a>
     - <a href="#minor-changes-4">Minor Changes</a>
+    - <a href="#deprecated-features-1">Deprecated Features</a>
     - <a href="#bugfixes-4">Bugfixes</a>
-    - <a href="#new-modules-2">New Modules</a>
-- <a href="#v9-2-0">v9\.2\.0</a>
+    - <a href="#new-modules-1">New Modules</a>
+- <a href="#v9-3-0">v9\.3\.0</a>
     - <a href="#release-summary-5">Release Summary</a>
     - <a href="#minor-changes-5">Minor Changes</a>
     - <a href="#bugfixes-5">Bugfixes</a>
+    - <a href="#new-modules-2">New Modules</a>
+- <a href="#v9-2-0">v9\.2\.0</a>
+    - <a href="#release-summary-6">Release Summary</a>
+    - <a href="#minor-changes-6">Minor Changes</a>
+    - <a href="#bugfixes-6">Bugfixes</a>
     - <a href="#new-plugins">New Plugins</a>
         - <a href="#filter">Filter</a>
         - <a href="#test">Test</a>
 - <a href="#v9-1-0">v9\.1\.0</a>
-    - <a href="#release-summary-6">Release Summary</a>
-    - <a href="#minor-changes-6">Minor Changes</a>
+    - <a href="#release-summary-7">Release Summary</a>
+    - <a href="#minor-changes-7">Minor Changes</a>
     - <a href="#deprecated-features-2">Deprecated Features</a>
-    - <a href="#bugfixes-6">Bugfixes</a>
+    - <a href="#bugfixes-7">Bugfixes</a>
     - <a href="#known-issues">Known Issues</a>
     - <a href="#new-plugins-1">New Plugins</a>
         - <a href="#filter-1">Filter</a>
     - <a href="#new-modules-3">New Modules</a>
 - <a href="#v9-0-1">v9\.0\.1</a>
-    - <a href="#release-summary-7">Release Summary</a>
-    - <a href="#minor-changes-7">Minor Changes</a>
-    - <a href="#bugfixes-7">Bugfixes</a>
-- <a href="#v9-0-0">v9\.0\.0</a>
     - <a href="#release-summary-8">Release Summary</a>
     - <a href="#minor-changes-8">Minor Changes</a>
+    - <a href="#bugfixes-8">Bugfixes</a>
+- <a href="#v9-0-0">v9\.0\.0</a>
+    - <a href="#release-summary-9">Release Summary</a>
+    - <a href="#minor-changes-9">Minor Changes</a>
     - <a href="#breaking-changes--porting-guide">Breaking Changes / Porting Guide</a>
     - <a href="#deprecated-features-3">Deprecated Features</a>
     - <a href="#removed-features-previously-deprecated">Removed Features \(previously deprecated\)</a>
-    - <a href="#security-fixes">Security Fixes</a>
-    - <a href="#bugfixes-8">Bugfixes</a>
+    - <a href="#security-fixes-1">Security Fixes</a>
+    - <a href="#bugfixes-9">Bugfixes</a>
     - <a href="#new-plugins-2">New Plugins</a>
         - <a href="#become">Become</a>
         - <a href="#callback">Callback</a>
@@ -65,8 +70,8 @@
     - <a href="#new-modules-4">New Modules</a>
 This changelog describes changes after version 8\.0\.0\.
 
-<a id="v9-5-2"></a>
-## v9\.5\.2
+<a id="v9-5-3"></a>
+## v9\.5\.3
 
 <a id="release-summary"></a>
 ### Release Summary
@@ -76,11 +81,39 @@ Regular bugfix release\.
 <a id="minor-changes"></a>
 ### Minor Changes
 
-* proxmox inventory plugin \- fix urllib3 <code>InsecureRequestWarnings</code> not being suppressed when a token is used \([https\://github\.com/ansible\-collections/community\.general/pull/9099](https\://github\.com/ansible\-collections/community\.general/pull/9099)\)\.
+* proxmox module utils \- add method <code>api\_task\_complete</code> that can wait for task completion and return error message \([https\://github\.com/ansible\-collections/community\.general/pull/9256](https\://github\.com/ansible\-collections/community\.general/pull/9256)\)\.
+
+<a id="security-fixes"></a>
+### Security Fixes
+
+* keycloak\_authentication \- API calls did not properly set the <code>priority</code> during update resulting in incorrectly sorted authentication flows\. This apparently only affects Keycloak 25 or newer \([https\://github\.com/ansible\-collections/community\.general/pull/9263](https\://github\.com/ansible\-collections/community\.general/pull/9263)\)\.
 
 <a id="bugfixes"></a>
 ### Bugfixes
 
+* dig lookup plugin \- correctly handle <code>NoNameserver</code> exception \([https\://github\.com/ansible\-collections/community\.general/pull/9363](https\://github\.com/ansible\-collections/community\.general/pull/9363)\, [https\://github\.com/ansible\-collections/community\.general/issues/9362](https\://github\.com/ansible\-collections/community\.general/issues/9362)\)\.
+* htpasswd \- report changes when file permissions are adjusted \([https\://github\.com/ansible\-collections/community\.general/issues/9485](https\://github\.com/ansible\-collections/community\.general/issues/9485)\, [https\://github\.com/ansible\-collections/community\.general/pull/9490](https\://github\.com/ansible\-collections/community\.general/pull/9490)\)\.
+* proxmox\_disk \- fix async method and make <code>resize\_disk</code> method handle errors correctly \([https\://github\.com/ansible\-collections/community\.general/pull/9256](https\://github\.com/ansible\-collections/community\.general/pull/9256)\)\.
+* proxmox\_template \- fix the wrong path called on <code>proxmox\_template\.task\_status</code> \([https\://github\.com/ansible\-collections/community\.general/issues/9276](https\://github\.com/ansible\-collections/community\.general/issues/9276)\, [https\://github\.com/ansible\-collections/community\.general/pull/9277](https\://github\.com/ansible\-collections/community\.general/pull/9277)\)\.
+* qubes connection plugin \- fix the printing of debug information \([https\://github\.com/ansible\-collections/community\.general/pull/9334](https\://github\.com/ansible\-collections/community\.general/pull/9334)\)\.
+* redfish\_utils module utils \- Fix <code>VerifyBiosAttributes</code> command on multi system resource nodes \([https\://github\.com/ansible\-collections/community\.general/pull/9234](https\://github\.com/ansible\-collections/community\.general/pull/9234)\)\.
+
+<a id="v9-5-2"></a>
+## v9\.5\.2
+
+<a id="release-summary-1"></a>
+### Release Summary
+
+Regular bugfix release\.
+
+<a id="minor-changes-1"></a>
+### Minor Changes
+
+* proxmox inventory plugin \- fix urllib3 <code>InsecureRequestWarnings</code> not being suppressed when a token is used \([https\://github\.com/ansible\-collections/community\.general/pull/9099](https\://github\.com/ansible\-collections/community\.general/pull/9099)\)\.
+
+<a id="bugfixes-1"></a>
+### Bugfixes
+
 * dnf\_config\_manager \- fix hanging when prompting to import GPG keys \([https\://github\.com/ansible\-collections/community\.general/pull/9124](https\://github\.com/ansible\-collections/community\.general/pull/9124)\, [https\://github\.com/ansible\-collections/community\.general/issues/8830](https\://github\.com/ansible\-collections/community\.general/issues/8830)\)\.
 * dnf\_config\_manager \- forces locale to <code>C</code> before module starts\. If the locale was set to non\-English\, the output of the <code>dnf config\-manager</code> could not be parsed \([https\://github\.com/ansible\-collections/community\.general/pull/9157](https\://github\.com/ansible\-collections/community\.general/pull/9157)\, [https\://github\.com/ansible\-collections/community\.general/issues/9046](https\://github\.com/ansible\-collections/community\.general/issues/9046)\)\.
 * flatpak \- force the locale language to <code>C</code> when running the flatpak command \([https\://github\.com/ansible\-collections/community\.general/pull/9187](https\://github\.com/ansible\-collections/community\.general/pull/9187)\, [https\://github\.com/ansible\-collections/community\.general/issues/8883](https\://github\.com/ansible\-collections/community\.general/issues/8883)\)\.
@@ -95,17 +128,17 @@ Regular bugfix release\.
 <a id="v9-5-1"></a>
 ## v9\.5\.1
 
-<a id="release-summary-1"></a>
+<a id="release-summary-2"></a>
 ### Release Summary
 
 Regular bugfix release\.
 
-<a id="minor-changes-1"></a>
+<a id="minor-changes-2"></a>
 ### Minor Changes
 
 * redfish\_utils module utils \- schedule a BIOS configuration job at next reboot when the BIOS config is changed \([https\://github\.com/ansible\-collections/community\.general/pull/9012](https\://github\.com/ansible\-collections/community\.general/pull/9012)\)\.
 
-<a id="bugfixes-1"></a>
+<a id="bugfixes-2"></a>
 ### Bugfixes
 
 * bitwarden lookup plugin \- support BWS v0\.3\.0 syntax breaking change \([https\://github\.com/ansible\-collections/community\.general/pull/9028](https\://github\.com/ansible\-collections/community\.general/pull/9028)\)\.
@@ -123,7 +156,7 @@ Regular bugfix release\.
 <a id="v9-5-0"></a>
 ## v9\.5\.0
 
-<a id="release-summary-2"></a>
+<a id="release-summary-3"></a>
 ### Release Summary
 
 Regular bugfix and feature release\.
@@ -131,7 +164,7 @@ Regular bugfix and feature release\.
 Please note that this is the last feature release for community\.general 9\.x\.y\.
 From now on\, new features will only go into community\.general 10\.x\.y\.
 
-<a id="minor-changes-2"></a>
+<a id="minor-changes-3"></a>
 ### Minor Changes
 
 * dig lookup plugin \- add <code>port</code> option to specify DNS server port \([https\://github\.com/ansible\-collections/community\.general/pull/8966](https\://github\.com/ansible\-collections/community\.general/pull/8966)\)\.
@@ -188,7 +221,7 @@ From now on\, new features will only go into community\.general 10\.x\.y\.
 
 * hipchat \- the hipchat service has been discontinued and the self\-hosted variant has been End of Life since 2020\. The module is therefore deprecated and will be removed from community\.general 11\.0\.0 if nobody provides compelling reasons to still keep it \([https\://github\.com/ansible\-collections/community\.general/pull/8919](https\://github\.com/ansible\-collections/community\.general/pull/8919)\)\.
 
-<a id="bugfixes-2"></a>
+<a id="bugfixes-3"></a>
 ### Bugfixes
 
 * cloudflare\_dns \- fix changing Cloudflare SRV records \([https\://github\.com/ansible\-collections/community\.general/issues/8679](https\://github\.com/ansible\-collections/community\.general/issues/8679)\, [https\://github\.com/ansible\-collections/community\.general/pull/8948](https\://github\.com/ansible\-collections/community\.general/pull/8948)\)\.
@@ -222,12 +255,12 @@ From now on\, new features will only go into community\.general 10\.x\.y\.
 <a id="v9-4-0"></a>
 ## v9\.4\.0
 
-<a id="release-summary-3"></a>
+<a id="release-summary-4"></a>
 ### Release Summary
 
 Bugfix and feature release\.
 
-<a id="minor-changes-3"></a>
+<a id="minor-changes-4"></a>
 ### Minor Changes
 
 * MH module utils \- add parameter <code>when</code> to <code>cause\_changes</code> decorator \([https\://github\.com/ansible\-collections/community\.general/pull/8766](https\://github\.com/ansible\-collections/community\.general/pull/8766)\)\.
@@ -314,7 +347,7 @@ Bugfix and feature release\.
 * pipx \- support for versions of the command line tool <code>pipx</code> older than <code>1\.7\.0</code> is deprecated and will be removed in community\.general 11\.0\.0 \([https\://github\.com/ansible\-collections/community\.general/pull/8793](https\://github\.com/ansible\-collections/community\.general/pull/8793)\)\.
 * pipx\_info \- support for versions of the command line tool <code>pipx</code> older than <code>1\.7\.0</code> is deprecated and will be removed in community\.general 11\.0\.0 \([https\://github\.com/ansible\-collections/community\.general/pull/8793](https\://github\.com/ansible\-collections/community\.general/pull/8793)\)\.
 
-<a id="bugfixes-3"></a>
+<a id="bugfixes-4"></a>
 ### Bugfixes
 
 * gitlab\_group\_access\_token \- fix crash in check mode caused by attempted access to a newly created access token \([https\://github\.com/ansible\-collections/community\.general/pull/8796](https\://github\.com/ansible\-collections/community\.general/pull/8796)\)\.
@@ -336,12 +369,12 @@ Bugfix and feature release\.
 <a id="v9-3-0"></a>
 ## v9\.3\.0
 
-<a id="release-summary-4"></a>
+<a id="release-summary-5"></a>
 ### Release Summary
 
 Regular bugfix and feature release\.
 
-<a id="minor-changes-4"></a>
+<a id="minor-changes-5"></a>
 ### Minor Changes
 
 * cgroup\_memory\_recap\, hipchat\, jabber\, log\_plays\, loganalytics\, logentries\, logstash\, slack\, splunk\, sumologic\, syslog\_json callback plugins \- make sure that all options are typed \([https\://github\.com/ansible\-collections/community\.general/pull/8628](https\://github\.com/ansible\-collections/community\.general/pull/8628)\)\.
@@ -364,7 +397,7 @@ Regular bugfix and feature release\.
 * proxmox inventory plugin \- add new fact for LXC interface details \([https\://github\.com/ansible\-collections/community\.general/pull/8713](https\://github\.com/ansible\-collections/community\.general/pull/8713)\)\.
 * redis\, redis\_info \- add <code>client\_cert</code> and <code>client\_key</code> options to specify path to certificate for Redis authentication  \([https\://github\.com/ansible\-collections/community\.general/pull/8654](https\://github\.com/ansible\-collections/community\.general/pull/8654)\)\.
 
-<a id="bugfixes-4"></a>
+<a id="bugfixes-5"></a>
 ### Bugfixes
 
 * gitlab\_runner \- fix <code>paused</code> parameter being ignored \([https\://github\.com/ansible\-collections/community\.general/pull/8648](https\://github\.com/ansible\-collections/community\.general/pull/8648)\)\.
@@ -385,12 +418,12 @@ Regular bugfix and feature release\.
 <a id="v9-2-0"></a>
 ## v9\.2\.0
 
-<a id="release-summary-5"></a>
+<a id="release-summary-6"></a>
 ### Release Summary
 
 Regular bugfix and feature release\.
 
-<a id="minor-changes-5"></a>
+<a id="minor-changes-6"></a>
 ### Minor Changes
 
 * CmdRunner module utils \- the parameter <code>force\_lang</code> now supports the special value <code>auto</code> which will automatically try and determine the best parsable locale in the system \([https\://github\.com/ansible\-collections/community\.general/pull/8517](https\://github\.com/ansible\-collections/community\.general/pull/8517)\)\.
@@ -402,7 +435,7 @@ Regular bugfix and feature release\.
 * virtualbox inventory plugin \- expose a new parameter <code>enable\_advanced\_group\_parsing</code> to change how the VirtualBox dynamic inventory parses VM groups \([https\://github\.com/ansible\-collections/community\.general/issues/8508](https\://github\.com/ansible\-collections/community\.general/issues/8508)\, [https\://github\.com/ansible\-collections/community\.general/pull/8510](https\://github\.com/ansible\-collections/community\.general/pull/8510)\)\.
 * wdc\_redfish\_command \- minor change to handle upgrade file for Redfish WD platforms \([https\://github\.com/ansible\-collections/community\.general/pull/8444](https\://github\.com/ansible\-collections/community\.general/pull/8444)\)\.
 
-<a id="bugfixes-5"></a>
+<a id="bugfixes-6"></a>
 ### Bugfixes
 
 * bitwarden lookup plugin \- fix <code>KeyError</code> in <code>search\_field</code> \([https\://github\.com/ansible\-collections/community\.general/issues/8549](https\://github\.com/ansible\-collections/community\.general/issues/8549)\, [https\://github\.com/ansible\-collections/community\.general/pull/8557](https\://github\.com/ansible\-collections/community\.general/pull/8557)\)\.
@@ -427,12 +460,12 @@ Regular bugfix and feature release\.
 <a id="v9-1-0"></a>
 ## v9\.1\.0
 
-<a id="release-summary-6"></a>
+<a id="release-summary-7"></a>
 ### Release Summary
 
 Regular feature and bugfix release\.
 
-<a id="minor-changes-6"></a>
+<a id="minor-changes-7"></a>
 ### Minor Changes
 
 * CmdRunner module util \- argument formats can be specified as plain functions without calling <code>cmd\_runner\_fmt\.as\_func\(\)</code> \([https\://github\.com/ansible\-collections/community\.general/pull/8479](https\://github\.com/ansible\-collections/community\.general/pull/8479)\)\.
@@ -456,7 +489,7 @@ Regular feature and bugfix release\.
 * git\_config \- the <code>list\_all</code> option has been deprecated and will be removed in community\.general 11\.0\.0\. Use the <code>community\.general\.git\_config\_info</code> module instead \([https\://github\.com/ansible\-collections/community\.general/pull/8453](https\://github\.com/ansible\-collections/community\.general/pull/8453)\)\.
 * git\_config \- using <code>state\=present</code> without providing <code>value</code> is deprecated and will be disallowed in community\.general 11\.0\.0\. Use the <code>community\.general\.git\_config\_info</code> module instead to read a value \([https\://github\.com/ansible\-collections/community\.general/pull/8453](https\://github\.com/ansible\-collections/community\.general/pull/8453)\)\.
 
-<a id="bugfixes-6"></a>
+<a id="bugfixes-7"></a>
 ### Bugfixes
 
 * git\_config \- fix behavior of <code>state\=absent</code> if <code>value</code> is present \([https\://github\.com/ansible\-collections/community\.general/issues/8436](https\://github\.com/ansible\-collections/community\.general/issues/8436)\, [https\://github\.com/ansible\-collections/community\.general/pull/8452](https\://github\.com/ansible\-collections/community\.general/pull/8452)\)\.
@@ -494,17 +527,17 @@ Regular feature and bugfix release\.
 <a id="v9-0-1"></a>
 ## v9\.0\.1
 
-<a id="release-summary-7"></a>
+<a id="release-summary-8"></a>
 ### Release Summary
 
 Bugfix release for inclusion in Ansible 10\.0\.0rc1\.
 
-<a id="minor-changes-7"></a>
+<a id="minor-changes-8"></a>
 ### Minor Changes
 
 * ansible\_galaxy\_install \- minor refactor in the module \([https\://github\.com/ansible\-collections/community\.general/pull/8413](https\://github\.com/ansible\-collections/community\.general/pull/8413)\)\.
 
-<a id="bugfixes-7"></a>
+<a id="bugfixes-8"></a>
 ### Bugfixes
 
 * cpanm \- use new <code>VarDict</code> to prevent deprecation warning \([https\://github\.com/ansible\-collections/community\.general/issues/8410](https\://github\.com/ansible\-collections/community\.general/issues/8410)\, [https\://github\.com/ansible\-collections/community\.general/pull/8411](https\://github\.com/ansible\-collections/community\.general/pull/8411)\)\.
@@ -523,12 +556,12 @@ Bugfix release for inclusion in Ansible 10\.0\.0rc1\.
 <a id="v9-0-0"></a>
 ## v9\.0\.0
 
-<a id="release-summary-8"></a>
+<a id="release-summary-9"></a>
 ### Release Summary
 
 This is release 9\.0\.0 of <code>community\.general</code>\, released on 2024\-05\-20\.
 
-<a id="minor-changes-8"></a>
+<a id="minor-changes-9"></a>
 ### Minor Changes
 
 * PythonRunner module utils \- specialisation of <code>CmdRunner</code> to execute Python scripts \([https\://github\.com/ansible\-collections/community\.general/pull/8289](https\://github\.com/ansible\-collections/community\.general/pull/8289)\)\.
@@ -692,13 +725,13 @@ This is release 9\.0\.0 of <code>community\.general</code>\, released on 2024\-0
 * stackdriver \- this module relied on HTTPS APIs that do not exist anymore and was thus removed \([https\://github\.com/ansible\-collections/community\.general/pull/8198](https\://github\.com/ansible\-collections/community\.general/pull/8198)\)\.
 * webfaction\_\* modules \- these modules relied on HTTPS APIs that do not exist anymore and were thus removed \([https\://github\.com/ansible\-collections/community\.general/pull/8198](https\://github\.com/ansible\-collections/community\.general/pull/8198)\)\.
 
-<a id="security-fixes"></a>
+<a id="security-fixes-1"></a>
 ### Security Fixes
 
 * cobbler\, gitlab\_runners\, icinga2\, linode\, lxd\, nmap\, online\, opennebula\, proxmox\, scaleway\, stackpath\_compute\, virtualbox\, and xen\_orchestra inventory plugin \- make sure all data received from the remote servers is marked as unsafe\, so remote code execution by obtaining texts that can be evaluated as templates is not possible \([https\://www\.die\-welt\.net/2024/03/remote\-code\-execution\-in\-ansible\-dynamic\-inventory\-plugins/](https\://www\.die\-welt\.net/2024/03/remote\-code\-execution\-in\-ansible\-dynamic\-inventory\-plugins/)\, [https\://github\.com/ansible\-collections/community\.general/pull/8098](https\://github\.com/ansible\-collections/community\.general/pull/8098)\)\.
 * keycloak\_identity\_provider \- the client secret was not correctly sanitized by the module\. The return values <code>proposed</code>\, <code>existing</code>\, and <code>end\_state</code>\, as well as the diff\, did contain the client secret unmasked \([https\://github\.com/ansible\-collections/community\.general/pull/8355](https\://github\.com/ansible\-collections/community\.general/pull/8355)\)\.
 
-<a id="bugfixes-8"></a>
+<a id="bugfixes-9"></a>
 ### Bugfixes
 
 * aix\_filesystem \- fix <code>\_validate\_vg</code> not passing VG name to <code>lsvg\_cmd</code> \([https\://github\.com/ansible\-collections/community\.general/issues/8151](https\://github\.com/ansible\-collections/community\.general/issues/8151)\)\.

CHANGELOG.rst

@@ -6,6 +6,34 @@ Community General Release Notes
 
 This changelog describes changes after version 8.0.0.
 
+v9.5.3
+======
+
+Release Summary
+---------------
+
+Regular bugfix release.
+
+Minor Changes
+-------------
+
+- proxmox module utils - add method ``api_task_complete`` that can wait for task completion and return error message (https://github.com/ansible-collections/community.general/pull/9256).
+
+Security Fixes
+--------------
+
+- keycloak_authentication - API calls did not properly set the ``priority`` during update resulting in incorrectly sorted authentication flows. This apparently only affects Keycloak 25 or newer (https://github.com/ansible-collections/community.general/pull/9263).
+
+Bugfixes
+--------
+
+- dig lookup plugin - correctly handle ``NoNameserver`` exception (https://github.com/ansible-collections/community.general/pull/9363, https://github.com/ansible-collections/community.general/issues/9362).
+- htpasswd - report changes when file permissions are adjusted (https://github.com/ansible-collections/community.general/issues/9485, https://github.com/ansible-collections/community.general/pull/9490).
+- proxmox_disk - fix async method and make ``resize_disk`` method handle errors correctly (https://github.com/ansible-collections/community.general/pull/9256).
+- proxmox_template - fix the wrong path called on ``proxmox_template.task_status`` (https://github.com/ansible-collections/community.general/issues/9276, https://github.com/ansible-collections/community.general/pull/9277).
+- qubes connection plugin - fix the printing of debug information (https://github.com/ansible-collections/community.general/pull/9334).
+- redfish_utils module utils - Fix ``VerifyBiosAttributes`` command on multi system resource nodes (https://github.com/ansible-collections/community.general/pull/9234).
+
 v9.5.2
 ======
 

changelogs/changelog.yaml

@@ -1509,3 +1509,35 @@ releases:
       - 9198-fail-if-slack-api-response-is-not-ok-with-error-message.yml
       - 9202-keycloak_clientscope_type-sort-lists.yml
     release_date: '2024-12-02'
+  9.5.3:
+    changes:
+      bugfixes:
+        - dig lookup plugin - correctly handle ``NoNameserver`` exception (https://github.com/ansible-collections/community.general/pull/9363,
+          https://github.com/ansible-collections/community.general/issues/9362).
+        - htpasswd - report changes when file permissions are adjusted (https://github.com/ansible-collections/community.general/issues/9485,
+          https://github.com/ansible-collections/community.general/pull/9490).
+        - proxmox_disk - fix async method and make ``resize_disk`` method handle errors
+          correctly (https://github.com/ansible-collections/community.general/pull/9256).
+        - proxmox_template - fix the wrong path called on ``proxmox_template.task_status``
+          (https://github.com/ansible-collections/community.general/issues/9276, https://github.com/ansible-collections/community.general/pull/9277).
+        - qubes connection plugin - fix the printing of debug information (https://github.com/ansible-collections/community.general/pull/9334).
+        - redfish_utils module utils - Fix ``VerifyBiosAttributes`` command on multi
+          system resource nodes (https://github.com/ansible-collections/community.general/pull/9234).
+      minor_changes:
+        - proxmox module utils - add method ``api_task_complete`` that can wait for
+          task completion and return error message (https://github.com/ansible-collections/community.general/pull/9256).
+      release_summary: Regular bugfix release.
+      security_fixes:
+        - keycloak_authentication - API calls did not properly set the ``priority``
+          during update resulting in incorrectly sorted authentication flows. This
+          apparently only affects Keycloak 25 or newer (https://github.com/ansible-collections/community.general/pull/9263).
+    fragments:
+      - 9.5.3.yml
+      - 9234-fix-verify-bios-attributes-multi-system.yml
+      - 9256-proxmox_disk-fix-async-method-of-resize_disk.yml
+      - 9263-kc_authentication-api-priority.yaml
+      - 9277-proxmox_template-fix-the-wrong-path-called-on-proxmox_template.task_status.yaml
+      - 9334-qubes-conn.yml
+      - 9363-dig-nonameservers.yml
+      - 9490-htpasswd-permissions.yml
+    release_date: '2024-12-31'

galaxy.yml

@@ -5,7 +5,7 @@
 
 namespace: community
 name: general
-version: 9.5.2
+version: 9.5.3
 readme: README.md
 authors:
   - Ansible (https://github.com/ansible)

plugins/cache/memcached.py

@@ -7,46 +7,46 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = '''
-    author: Unknown (!UNKNOWN)
-    name: memcached
-    short_description: Use memcached DB for cache
+DOCUMENTATION = r"""
+author: Unknown (!UNKNOWN)
+name: memcached
+short_description: Use memcached DB for cache
+description:
+  - This cache uses JSON formatted, per host records saved in memcached.
+requirements:
+  - memcache (python lib)
+options:
+  _uri:
     description:
-        - This cache uses JSON formatted, per host records saved in memcached.
-    requirements:
-      - memcache (python lib)
-    options:
-      _uri:
-        description:
-          - List of connection information for the memcached DBs
-        default: ['127.0.0.1:11211']
-        type: list
-        elements: string
-        env:
-          - name: ANSIBLE_CACHE_PLUGIN_CONNECTION
-        ini:
-          - key: fact_caching_connection
-            section: defaults
-      _prefix:
-        description: User defined prefix to use when creating the DB entries
-        type: string
-        default: ansible_facts
-        env:
-          - name: ANSIBLE_CACHE_PLUGIN_PREFIX
-        ini:
-          - key: fact_caching_prefix
-            section: defaults
-      _timeout:
-        default: 86400
-        type: integer
+      - List of connection information for the memcached DBs.
+    default: ['127.0.0.1:11211']
+    type: list
+    elements: string
+    env:
+      - name: ANSIBLE_CACHE_PLUGIN_CONNECTION
+    ini:
+      - key: fact_caching_connection
+        section: defaults
+  _prefix:
+    description: User defined prefix to use when creating the DB entries.
+    type: string
+    default: ansible_facts
+    env:
+      - name: ANSIBLE_CACHE_PLUGIN_PREFIX
+    ini:
+      - key: fact_caching_prefix
+        section: defaults
+  _timeout:
+    default: 86400
+    type: integer
         # TODO: determine whether it is OK to change to: type: float
-        description: Expiration timeout in seconds for the cache plugin data. Set to 0 to never expire
-        env:
-          - name: ANSIBLE_CACHE_PLUGIN_TIMEOUT
-        ini:
-          - key: fact_caching_timeout
-            section: defaults
-'''
+    description: Expiration timeout in seconds for the cache plugin data. Set to 0 to never expire.
+    env:
+      - name: ANSIBLE_CACHE_PLUGIN_TIMEOUT
+    ini:
+      - key: fact_caching_timeout
+        section: defaults
+"""
 
 import collections
 import os

plugins/cache/pickle.py

@@ -8,41 +8,41 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = '''
-    name: pickle
-    short_description: Pickle formatted files.
+DOCUMENTATION = r"""
+name: pickle
+short_description: Pickle formatted files
+description:
+  - This cache uses Python's pickle serialization format, in per host files, saved to the filesystem.
+author: Brian Coca (@bcoca)
+options:
+  _uri:
+    required: true
     description:
-        - This cache uses Python's pickle serialization format, in per host files, saved to the filesystem.
-    author: Brian Coca (@bcoca)
-    options:
-      _uri:
-        required: true
-        description:
-          - Path in which the cache plugin will save the files
-        env:
-          - name: ANSIBLE_CACHE_PLUGIN_CONNECTION
-        ini:
-          - key: fact_caching_connection
-            section: defaults
-        type: path
-      _prefix:
-        description: User defined prefix to use when creating the files
-        env:
-          - name: ANSIBLE_CACHE_PLUGIN_PREFIX
-        ini:
-          - key: fact_caching_prefix
-            section: defaults
-        type: string
-      _timeout:
-        default: 86400
-        description: Expiration timeout in seconds for the cache plugin data. Set to 0 to never expire
-        env:
-          - name: ANSIBLE_CACHE_PLUGIN_TIMEOUT
-        ini:
-          - key: fact_caching_timeout
-            section: defaults
-        type: float
-'''
+      - Path in which the cache plugin will save the files.
+    env:
+      - name: ANSIBLE_CACHE_PLUGIN_CONNECTION
+    ini:
+      - key: fact_caching_connection
+        section: defaults
+    type: path
+  _prefix:
+    description: User defined prefix to use when creating the files.
+    env:
+      - name: ANSIBLE_CACHE_PLUGIN_PREFIX
+    ini:
+      - key: fact_caching_prefix
+        section: defaults
+    type: string
+  _timeout:
+    default: 86400
+    description: Expiration timeout in seconds for the cache plugin data. Set to 0 to never expire.
+    env:
+      - name: ANSIBLE_CACHE_PLUGIN_TIMEOUT
+    ini:
+      - key: fact_caching_timeout
+        section: defaults
+    type: float
+"""
 
 try:
     import cPickle as pickle

plugins/cache/redis.py

@@ -6,67 +6,67 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = '''
-    author: Unknown (!UNKNOWN)
-    name: redis
-    short_description: Use Redis DB for cache
+DOCUMENTATION = r"""
+author: Unknown (!UNKNOWN)
+name: redis
+short_description: Use Redis DB for cache
+description:
+  - This cache uses JSON formatted, per host records saved in Redis.
+requirements:
+  - redis>=2.4.5 (python lib)
+options:
+  _uri:
     description:
-        - This cache uses JSON formatted, per host records saved in Redis.
-    requirements:
-      - redis>=2.4.5 (python lib)
-    options:
-      _uri:
-        description:
-          - A colon separated string of connection information for Redis.
-          - The format is V(host:port:db:password), for example V(localhost:6379:0:changeme).
-          - To use encryption in transit, prefix the connection with V(tls://), as in V(tls://localhost:6379:0:changeme).
-          - To use redis sentinel, use separator V(;), for example V(localhost:26379;localhost:26379;0:changeme). Requires redis>=2.9.0.
-        type: string
-        required: true
-        env:
-          - name: ANSIBLE_CACHE_PLUGIN_CONNECTION
-        ini:
-          - key: fact_caching_connection
-            section: defaults
-      _prefix:
-        description: User defined prefix to use when creating the DB entries
-        type: string
-        default: ansible_facts
-        env:
-          - name: ANSIBLE_CACHE_PLUGIN_PREFIX
-        ini:
-          - key: fact_caching_prefix
-            section: defaults
-      _keyset_name:
-        description: User defined name for cache keyset name.
-        type: string
-        default: ansible_cache_keys
-        env:
-          - name: ANSIBLE_CACHE_REDIS_KEYSET_NAME
-        ini:
-          - key: fact_caching_redis_keyset_name
-            section: defaults
-        version_added: 1.3.0
-      _sentinel_service_name:
-        description: The redis sentinel service name (or referenced as cluster name).
-        type: string
-        env:
-          - name: ANSIBLE_CACHE_REDIS_SENTINEL
-        ini:
-          - key: fact_caching_redis_sentinel
-            section: defaults
-        version_added: 1.3.0
-      _timeout:
-        default: 86400
-        type: integer
+      - A colon separated string of connection information for Redis.
+      - The format is V(host:port:db:password), for example V(localhost:6379:0:changeme).
+      - To use encryption in transit, prefix the connection with V(tls://), as in V(tls://localhost:6379:0:changeme).
+      - To use redis sentinel, use separator V(;), for example V(localhost:26379;localhost:26379;0:changeme). Requires redis>=2.9.0.
+    type: string
+    required: true
+    env:
+      - name: ANSIBLE_CACHE_PLUGIN_CONNECTION
+    ini:
+      - key: fact_caching_connection
+        section: defaults
+  _prefix:
+    description: User defined prefix to use when creating the DB entries.
+    type: string
+    default: ansible_facts
+    env:
+      - name: ANSIBLE_CACHE_PLUGIN_PREFIX
+    ini:
+      - key: fact_caching_prefix
+        section: defaults
+  _keyset_name:
+    description: User defined name for cache keyset name.
+    type: string
+    default: ansible_cache_keys
+    env:
+      - name: ANSIBLE_CACHE_REDIS_KEYSET_NAME
+    ini:
+      - key: fact_caching_redis_keyset_name
+        section: defaults
+    version_added: 1.3.0
+  _sentinel_service_name:
+    description: The redis sentinel service name (or referenced as cluster name).
+    type: string
+    env:
+      - name: ANSIBLE_CACHE_REDIS_SENTINEL
+    ini:
+      - key: fact_caching_redis_sentinel
+        section: defaults
+    version_added: 1.3.0
+  _timeout:
+    default: 86400
+    type: integer
         # TODO: determine whether it is OK to change to: type: float
-        description: Expiration timeout in seconds for the cache plugin data. Set to 0 to never expire
-        env:
-          - name: ANSIBLE_CACHE_PLUGIN_TIMEOUT
-        ini:
-          - key: fact_caching_timeout
-            section: defaults
-'''
+    description: Expiration timeout in seconds for the cache plugin data. Set to 0 to never expire.
+    env:
+      - name: ANSIBLE_CACHE_PLUGIN_TIMEOUT
+    ini:
+      - key: fact_caching_timeout
+        section: defaults
+"""
 
 import re
 import time

plugins/cache/yaml.py

@@ -8,42 +8,42 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = '''
-    name: yaml
-    short_description: YAML formatted files.
+DOCUMENTATION = r"""
+name: yaml
+short_description: YAML formatted files
+description:
+  - This cache uses YAML formatted, per host, files saved to the filesystem.
+author: Brian Coca (@bcoca)
+options:
+  _uri:
+    required: true
     description:
-        - This cache uses YAML formatted, per host, files saved to the filesystem.
-    author: Brian Coca (@bcoca)
-    options:
-      _uri:
-        required: true
-        description:
-          - Path in which the cache plugin will save the files
-        env:
-          - name: ANSIBLE_CACHE_PLUGIN_CONNECTION
-        ini:
-          - key: fact_caching_connection
-            section: defaults
-        type: string
-      _prefix:
-        description: User defined prefix to use when creating the files
-        env:
-          - name: ANSIBLE_CACHE_PLUGIN_PREFIX
-        ini:
-          - key: fact_caching_prefix
-            section: defaults
-        type: string
-      _timeout:
-        default: 86400
-        description: Expiration timeout in seconds for the cache plugin data. Set to 0 to never expire
-        env:
-          - name: ANSIBLE_CACHE_PLUGIN_TIMEOUT
-        ini:
-          - key: fact_caching_timeout
-            section: defaults
-        type: integer
+      - Path in which the cache plugin will save the files.
+    env:
+      - name: ANSIBLE_CACHE_PLUGIN_CONNECTION
+    ini:
+      - key: fact_caching_connection
+        section: defaults
+    type: string
+  _prefix:
+    description: User defined prefix to use when creating the files.
+    env:
+      - name: ANSIBLE_CACHE_PLUGIN_PREFIX
+    ini:
+      - key: fact_caching_prefix
+        section: defaults
+    type: string
+  _timeout:
+    default: 86400
+    description: Expiration timeout in seconds for the cache plugin data. Set to 0 to never expire.
+    env:
+      - name: ANSIBLE_CACHE_PLUGIN_TIMEOUT
+    ini:
+      - key: fact_caching_timeout
+        section: defaults
+    type: integer
         # TODO: determine whether it is OK to change to: type: float
-'''
+"""
 
 
 import codecs

plugins/callback/cgroup_memory_recap.py

@@ -7,40 +7,41 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = '''
-    author: Unknown (!UNKNOWN)
-    name: cgroup_memory_recap
-    type: aggregate
-    requirements:
-      - whitelist in configuration
-      - cgroups
-    short_description: Profiles maximum memory usage of tasks and full execution using cgroups
-    description:
-        - This is an ansible callback plugin that profiles maximum memory usage of ansible and individual tasks, and displays a recap at the end using cgroups.
-    notes:
-        - Requires ansible to be run from within a cgroup, such as with C(cgexec -g memory:ansible_profile ansible-playbook ...).
-        - This cgroup should only be used by ansible to get accurate results.
-        - To create the cgroup, first use a command such as C(sudo cgcreate -a ec2-user:ec2-user -t ec2-user:ec2-user -g memory:ansible_profile).
-    options:
-      max_mem_file:
-        required: true
-        description: Path to cgroups C(memory.max_usage_in_bytes) file. Example V(/sys/fs/cgroup/memory/ansible_profile/memory.max_usage_in_bytes).
-        type: str
-        env:
-          - name: CGROUP_MAX_MEM_FILE
-        ini:
-          - section: callback_cgroupmemrecap
-            key: max_mem_file
-      cur_mem_file:
-        required: true
-        description: Path to C(memory.usage_in_bytes) file. Example V(/sys/fs/cgroup/memory/ansible_profile/memory.usage_in_bytes).
-        type: str
-        env:
-          - name: CGROUP_CUR_MEM_FILE
-        ini:
-          - section: callback_cgroupmemrecap
-            key: cur_mem_file
-'''
+DOCUMENTATION = r"""
+author: Unknown (!UNKNOWN)
+name: cgroup_memory_recap
+type: aggregate
+requirements:
+  - whitelist in configuration
+  - cgroups
+short_description: Profiles maximum memory usage of tasks and full execution using cgroups
+description:
+  - This is an Ansible callback plugin that profiles maximum memory usage of Ansible and individual tasks, and displays a
+    recap at the end using cgroups.
+notes:
+  - Requires ansible to be run from within a C(cgroup), such as with C(cgexec -g memory:ansible_profile ansible-playbook ...).
+  - This C(cgroup) should only be used by Ansible to get accurate results.
+  - To create the C(cgroup), first use a command such as C(sudo cgcreate -a ec2-user:ec2-user -t ec2-user:ec2-user -g memory:ansible_profile).
+options:
+  max_mem_file:
+    required: true
+    description: Path to cgroups C(memory.max_usage_in_bytes) file. Example V(/sys/fs/cgroup/memory/ansible_profile/memory.max_usage_in_bytes).
+    type: str
+    env:
+      - name: CGROUP_MAX_MEM_FILE
+    ini:
+      - section: callback_cgroupmemrecap
+        key: max_mem_file
+  cur_mem_file:
+    required: true
+    description: Path to C(memory.usage_in_bytes) file. Example V(/sys/fs/cgroup/memory/ansible_profile/memory.usage_in_bytes).
+    type: str
+    env:
+      - name: CGROUP_CUR_MEM_FILE
+    ini:
+      - section: callback_cgroupmemrecap
+        key: cur_mem_file
+"""
 
 import time
 import threading

plugins/callback/context_demo.py

@@ -7,17 +7,17 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = '''
-    author: Unknown (!UNKNOWN)
-    name: context_demo
-    type: aggregate
-    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.
-    requirements:
-      - whitelist in configuration
-'''
+DOCUMENTATION = r"""
+author: Unknown (!UNKNOWN)
+name: context_demo
+type: aggregate
+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.
+requirements:
+  - whitelist in configuration
+"""
 
 from ansible.plugins.callback import CallbackBase
 

plugins/callback/counter_enabled.py

@@ -9,20 +9,20 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = '''
-    author: Unknown (!UNKNOWN)
-    name: counter_enabled
-    type: stdout
-    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.
-      - You will know how many hosts may run a task, and which of them is actually running.
-    extends_documentation_fragment:
-      - default_callback
-    requirements:
-      - set as stdout callback in C(ansible.cfg) (C(stdout_callback = counter_enabled))
-'''
+DOCUMENTATION = r"""
+author: Unknown (!UNKNOWN)
+name: counter_enabled
+type: stdout
+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.
+  - You will know how many hosts may run a task, and which of them is actually running.
+extends_documentation_fragment:
+  - default_callback
+requirements:
+  - set as stdout callback in C(ansible.cfg) (C(stdout_callback = counter_enabled))
+"""
 
 from ansible import constants as C
 from ansible.plugins.callback import CallbackBase

plugins/callback/default_without_diff.py

@@ -7,23 +7,22 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = r'''
-  name: default_without_diff
-  type: stdout
-  short_description: The default ansible callback without diff output
-  version_added: 8.4.0
-  description:
-    - This is basically the default ansible callback plugin (P(ansible.builtin.default#callback)) without
-      showing diff output. This can be useful when using another callback which sends more detailed information
-      to another service, like the L(ARA, https://ara.recordsansible.org/) callback, and you want diff output
-      sent to that plugin but not shown on the console output.
-  author: Felix Fontein (@felixfontein)
-  extends_documentation_fragment:
-    - ansible.builtin.default_callback
-    - ansible.builtin.result_format_callback
-'''
+DOCUMENTATION = r"""
+name: default_without_diff
+type: stdout
+short_description: The default ansible callback without diff output
+version_added: 8.4.0
+description:
+  - This is basically the default ansible callback plugin (P(ansible.builtin.default#callback)) without showing diff output.
+    This can be useful when using another callback which sends more detailed information to another service, like the L(ARA,
+    https://ara.recordsansible.org/) callback, and you want diff output sent to that plugin but not shown on the console output.
+author: Felix Fontein (@felixfontein)
+extends_documentation_fragment:
+  - ansible.builtin.default_callback
+  - ansible.builtin.result_format_callback
+"""
 
-EXAMPLES = r'''
+EXAMPLES = r"""
 # Enable callback in ansible.cfg:
 ansible_config: |
   [defaults]
@@ -32,7 +31,7 @@ ansible_config: |
 # Enable callback with environment variables:
 environment_variable: |
   ANSIBLE_STDOUT_CALLBACK=community.general.default_without_diff
-'''
+"""
 
 from ansible.plugins.callback.default import CallbackModule as Default
 

plugins/callback/dense.py

@@ -7,19 +7,19 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = '''
+DOCUMENTATION = r"""
 name: dense
 type: stdout
 short_description: minimal stdout output
 extends_documentation_fragment:
-- default_callback
+  - default_callback
 description:
-- When in verbose mode it will act the same as the default callback.
+  - When in verbose mode it will act the same as the default callback.
 author:
-- Dag Wieers (@dagwieers)
+  - Dag Wieers (@dagwieers)
 requirements:
-- set as stdout in configuration
-'''
+  - set as stdout in configuration
+"""
 
 HAS_OD = False
 try:

plugins/callback/elastic.py

@@ -5,69 +5,69 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = '''
-    author: Victor Martinez (@v1v)  <VictorMartinezRubio@gmail.com>
-    name: elastic
-    type: notification
-    short_description: Create distributed traces for each Ansible task in Elastic APM
-    version_added: 3.8.0
+DOCUMENTATION = r"""
+author: Victor Martinez (@v1v)  <VictorMartinezRubio@gmail.com>
+name: elastic
+type: notification
+short_description: Create distributed traces for each Ansible task in Elastic APM
+version_added: 3.8.0
+description:
+  - This callback creates distributed traces for each Ansible task in Elastic APM.
+  - You can configure the plugin with environment variables.
+  - See U(https://www.elastic.co/guide/en/apm/agent/python/current/configuration.html).
+options:
+  hide_task_arguments:
+    default: false
+    type: bool
     description:
-      - This callback creates distributed traces for each Ansible task in Elastic APM.
-      - You can configure the plugin with environment variables.
-      - See U(https://www.elastic.co/guide/en/apm/agent/python/current/configuration.html).
-    options:
-      hide_task_arguments:
-        default: false
-        type: bool
-        description:
-          - Hide the arguments for a task.
-        env:
-          - name: ANSIBLE_OPENTELEMETRY_HIDE_TASK_ARGUMENTS
-      apm_service_name:
-        default: ansible
-        type: str
-        description:
-          - The service name resource attribute.
-        env:
-          - name: ELASTIC_APM_SERVICE_NAME
-      apm_server_url:
-        type: str
-        description:
-          - Use the APM server and its environment variables.
-        env:
-          - name: ELASTIC_APM_SERVER_URL
-      apm_secret_token:
-        type: str
-        description:
-          - Use the APM server token
-        env:
-          - name: ELASTIC_APM_SECRET_TOKEN
-      apm_api_key:
-        type: str
-        description:
-          - Use the APM API key
-        env:
-          - name: ELASTIC_APM_API_KEY
-      apm_verify_server_cert:
-        default: true
-        type: bool
-        description:
-          - Verifies the SSL certificate if an HTTPS connection.
-        env:
-          - name: ELASTIC_APM_VERIFY_SERVER_CERT
-      traceparent:
-        type: str
-        description:
-          - The L(W3C Trace Context header traceparent,https://www.w3.org/TR/trace-context-1/#traceparent-header).
-        env:
-          - name: TRACEPARENT
-    requirements:
-      - elastic-apm (Python library)
-'''
+      - Hide the arguments for a task.
+    env:
+      - name: ANSIBLE_OPENTELEMETRY_HIDE_TASK_ARGUMENTS
+  apm_service_name:
+    default: ansible
+    type: str
+    description:
+      - The service name resource attribute.
+    env:
+      - name: ELASTIC_APM_SERVICE_NAME
+  apm_server_url:
+    type: str
+    description:
+      - Use the APM server and its environment variables.
+    env:
+      - name: ELASTIC_APM_SERVER_URL
+  apm_secret_token:
+    type: str
+    description:
+      - Use the APM server token.
+    env:
+      - name: ELASTIC_APM_SECRET_TOKEN
+  apm_api_key:
+    type: str
+    description:
+      - Use the APM API key.
+    env:
+      - name: ELASTIC_APM_API_KEY
+  apm_verify_server_cert:
+    default: true
+    type: bool
+    description:
+      - Verifies the SSL certificate if an HTTPS connection.
+    env:
+      - name: ELASTIC_APM_VERIFY_SERVER_CERT
+  traceparent:
+    type: str
+    description:
+      - The L(W3C Trace Context header traceparent,https://www.w3.org/TR/trace-context-1/#traceparent-header).
+    env:
+      - name: TRACEPARENT
+requirements:
+  - elastic-apm (Python library)
+"""
 
 
-EXAMPLES = '''
-examples: |
+EXAMPLES = r"""
+examples: |-
   Enable the plugin in ansible.cfg:
     [defaults]
     callbacks_enabled = community.general.elastic
@@ -76,7 +76,7 @@ examples: |
     export ELASTIC_APM_SERVER_URL=<your APM server URL)>
     export ELASTIC_APM_SERVICE_NAME=your_service_name
     export ELASTIC_APM_API_KEY=your_APM_API_KEY
-'''
+"""
 
 import getpass
 import socket

plugins/callback/jabber.py

@@ -7,42 +7,42 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = '''
-    author: Unknown (!UNKNOWN)
-    name: jabber
-    type: notification
-    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.
-    requirements:
-      - xmpp (Python library U(https://github.com/ArchipelProject/xmpppy))
-    options:
-      server:
-        description: connection info to jabber server
-        type: str
-        required: true
-        env:
-          - name: JABBER_SERV
-      user:
-        description: Jabber user to authenticate as
-        type: str
-        required: true
-        env:
-          - name: JABBER_USER
-      password:
-        description: Password for the user to the jabber server
-        type: str
-        required: true
-        env:
-          - name: JABBER_PASS
-      to:
-        description: chat identifier that will receive the message
-        type: str
-        required: true
-        env:
-          - name: JABBER_TO
-'''
+DOCUMENTATION = r"""
+author: Unknown (!UNKNOWN)
+name: jabber
+type: notification
+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.
+requirements:
+  - xmpp (Python library U(https://github.com/ArchipelProject/xmpppy))
+options:
+  server:
+    description: Connection info to Jabber server.
+    type: str
+    required: true
+    env:
+      - name: JABBER_SERV
+  user:
+    description: Jabber user to authenticate as.
+    type: str
+    required: true
+    env:
+      - name: JABBER_USER
+  password:
+    description: Password for the user to the Jabber server.
+    type: str
+    required: true
+    env:
+      - name: JABBER_PASS
+  to:
+    description: Chat identifier that will receive the message.
+    type: str
+    required: true
+    env:
+      - name: JABBER_TO
+"""
 
 import os
 

plugins/callback/log_plays.py

@@ -7,27 +7,27 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = '''
-    author: Unknown (!UNKNOWN)
-    name: log_plays
-    type: notification
-    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:
-     - Whitelist in configuration
-     - A writeable C(/var/log/ansible/hosts) directory by the user executing Ansible on the controller
-    options:
-      log_folder:
-        default: /var/log/ansible/hosts
-        description: The folder where log files will be created.
-        type: str
-        env:
-          - name: ANSIBLE_LOG_FOLDER
-        ini:
-          - section: callback_log_plays
-            key: log_folder
-'''
+DOCUMENTATION = r"""
+author: Unknown (!UNKNOWN)
+name: log_plays
+type: notification
+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:
+  - Whitelist in configuration
+  - A writeable C(/var/log/ansible/hosts) directory by the user executing Ansible on the controller
+options:
+  log_folder:
+    default: /var/log/ansible/hosts
+    description: The folder where log files will be created.
+    type: str
+    env:
+      - name: ANSIBLE_LOG_FOLDER
+    ini:
+      - section: callback_log_plays
+        key: log_folder
+"""
 
 import os
 import time

plugins/callback/loganalytics.py

@@ -6,41 +6,41 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = '''
-    name: loganalytics
-    type: notification
-    short_description: Posts task results to Azure Log Analytics
-    author: "Cyrus Li (@zhcli) <cyrus1006@gmail.com>"
-    description:
-      - This callback plugin will post task results in JSON formatted to an Azure Log Analytics workspace.
-      - Credits to authors of splunk callback plugin.
-    version_added: "2.4.0"
-    requirements:
-      - Whitelisting this callback plugin.
-      - An Azure log analytics work space has been established.
-    options:
-      workspace_id:
-        description: Workspace ID of the Azure log analytics workspace.
-        type: str
-        required: true
-        env:
-          - name: WORKSPACE_ID
-        ini:
-          - section: callback_loganalytics
-            key: workspace_id
-      shared_key:
-        description: Shared key to connect to Azure log analytics workspace.
-        type: str
-        required: true
-        env:
-          - name: WORKSPACE_SHARED_KEY
-        ini:
-          - section: callback_loganalytics
-            key: shared_key
-'''
+DOCUMENTATION = r"""
+name: loganalytics
+type: notification
+short_description: Posts task results to Azure Log Analytics
+author: "Cyrus Li (@zhcli) <cyrus1006@gmail.com>"
+description:
+  - This callback plugin will post task results in JSON formatted to an Azure Log Analytics workspace.
+  - Credits to authors of splunk callback plugin.
+version_added: "2.4.0"
+requirements:
+  - Whitelisting this callback plugin.
+  - An Azure log analytics work space has been established.
+options:
+  workspace_id:
+    description: Workspace ID of the Azure log analytics workspace.
+    type: str
+    required: true
+    env:
+      - name: WORKSPACE_ID
+    ini:
+      - section: callback_loganalytics
+        key: workspace_id
+  shared_key:
+    description: Shared key to connect to Azure log analytics workspace.
+    type: str
+    required: true
+    env:
+      - name: WORKSPACE_SHARED_KEY
+    ini:
+      - section: callback_loganalytics
+        key: shared_key
+"""
 
-EXAMPLES = '''
-examples: |
+EXAMPLES = r"""
+examples: |-
   Whitelist the plugin in ansible.cfg:
     [defaults]
     callback_whitelist = community.general.loganalytics
@@ -51,7 +51,7 @@ examples: |
     [callback_loganalytics]
     workspace_id = 01234567-0123-0123-0123-01234567890a
     shared_key = dZD0kCbKl3ehZG6LHFMuhtE0yHiFCmetzFMc2u+roXIUQuatqU924SsAAAAPemhjbGlAemhjbGktTUJQAQIDBA==
-'''
+"""
 
 import hashlib
 import hmac

plugins/callback/logdna.py

@@ -6,56 +6,56 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = '''
-    author: Unknown (!UNKNOWN)
-    name: logdna
-    type: notification
-    short_description: Sends playbook logs to LogDNA
-    description:
-      - This callback will report logs from playbook actions, tasks, and events to LogDNA (U(https://app.logdna.com)).
-    requirements:
-      - LogDNA Python Library (U(https://github.com/logdna/python))
-      - whitelisting in configuration
-    options:
-      conf_key:
-        required: true
-        description: LogDNA Ingestion Key.
-        type: string
-        env:
-          - name: LOGDNA_INGESTION_KEY
-        ini:
-          - section: callback_logdna
-            key: conf_key
-      plugin_ignore_errors:
-        required: false
-        description: Whether to ignore errors on failing or not.
-        type: boolean
-        env:
-          - name: ANSIBLE_IGNORE_ERRORS
-        ini:
-          - section: callback_logdna
-            key: plugin_ignore_errors
-        default: false
-      conf_hostname:
-        required: false
-        description: Alternative Host Name; the current host name by default.
-        type: string
-        env:
-          - name: LOGDNA_HOSTNAME
-        ini:
-          - section: callback_logdna
-            key: conf_hostname
-      conf_tags:
-        required: false
-        description: Tags.
-        type: string
-        env:
-          - name: LOGDNA_TAGS
-        ini:
-          - section: callback_logdna
-            key: conf_tags
-        default: ansible
-'''
+DOCUMENTATION = r"""
+author: Unknown (!UNKNOWN)
+name: logdna
+type: notification
+short_description: Sends playbook logs to LogDNA
+description:
+  - This callback will report logs from playbook actions, tasks, and events to LogDNA (U(https://app.logdna.com)).
+requirements:
+  - LogDNA Python Library (U(https://github.com/logdna/python))
+  - whitelisting in configuration
+options:
+  conf_key:
+    required: true
+    description: LogDNA Ingestion Key.
+    type: string
+    env:
+      - name: LOGDNA_INGESTION_KEY
+    ini:
+      - section: callback_logdna
+        key: conf_key
+  plugin_ignore_errors:
+    required: false
+    description: Whether to ignore errors on failing or not.
+    type: boolean
+    env:
+      - name: ANSIBLE_IGNORE_ERRORS
+    ini:
+      - section: callback_logdna
+        key: plugin_ignore_errors
+    default: false
+  conf_hostname:
+    required: false
+    description: Alternative Host Name; the current host name by default.
+    type: string
+    env:
+      - name: LOGDNA_HOSTNAME
+    ini:
+      - section: callback_logdna
+        key: conf_hostname
+  conf_tags:
+    required: false
+    description: Tags.
+    type: string
+    env:
+      - name: LOGDNA_TAGS
+    ini:
+      - section: callback_logdna
+        key: conf_tags
+    default: ansible
+"""
 
 import logging
 import json

plugins/callback/logentries.py

@@ -6,79 +6,77 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = '''
-    author: Unknown (!UNKNOWN)
-    name: logentries
-    type: notification
-    short_description: Sends events to Logentries
+DOCUMENTATION = r"""
+author: Unknown (!UNKNOWN)
+name: logentries
+type: notification
+short_description: Sends events to Logentries
+description:
+  - This callback plugin will generate JSON objects and send them to Logentries using TCP for auditing/debugging purposes.
+requirements:
+  - whitelisting in configuration
+  - certifi (Python library)
+  - flatdict (Python library), if you want to use the O(flatten) option
+options:
+  api:
+    description: URI to the Logentries API.
+    type: str
+    env:
+      - name: LOGENTRIES_API
+    default: data.logentries.com
+    ini:
+      - section: callback_logentries
+        key: api
+  port:
+    description: HTTP port to use when connecting to the API.
+    type: int
+    env:
+      - name: LOGENTRIES_PORT
+    default: 80
+    ini:
+      - section: callback_logentries
+        key: port
+  tls_port:
+    description: Port to use when connecting to the API when TLS is enabled.
+    type: int
+    env:
+      - name: LOGENTRIES_TLS_PORT
+    default: 443
+    ini:
+      - section: callback_logentries
+        key: tls_port
+  token:
+    description: The logentries C(TCP token).
+    type: str
+    env:
+      - name: LOGENTRIES_ANSIBLE_TOKEN
+    required: true
+    ini:
+      - section: callback_logentries
+        key: token
+  use_tls:
     description:
-      - This callback plugin will generate JSON objects and send them to Logentries via TCP for auditing/debugging purposes.
-      - Before 2.4, if you wanted to use an ini configuration, the file must be placed in the same directory as this plugin and named C(logentries.ini).
-      - In 2.4 and above you can just put it in the main Ansible configuration file.
-    requirements:
-      - whitelisting in configuration
-      - certifi (Python library)
-      - flatdict (Python library), if you want to use the O(flatten) option
-    options:
-      api:
-        description: URI to the Logentries API.
-        type: str
-        env:
-          - name: LOGENTRIES_API
-        default: data.logentries.com
-        ini:
-          - section: callback_logentries
-            key: api
-      port:
-        description: HTTP port to use when connecting to the API.
-        type: int
-        env:
-            - name: LOGENTRIES_PORT
-        default: 80
-        ini:
-          - section: callback_logentries
-            key: port
-      tls_port:
-        description: Port to use when connecting to the API when TLS is enabled.
-        type: int
-        env:
-            - name: LOGENTRIES_TLS_PORT
-        default: 443
-        ini:
-          - section: callback_logentries
-            key: tls_port
-      token:
-        description: The logentries C(TCP token).
-        type: str
-        env:
-          - name: LOGENTRIES_ANSIBLE_TOKEN
-        required: true
-        ini:
-          - section: callback_logentries
-            key: token
-      use_tls:
-        description:
-          - Toggle to decide whether to use TLS to encrypt the communications with the API server.
-        env:
-          - name: LOGENTRIES_USE_TLS
-        default: false
-        type: boolean
-        ini:
-          - section: callback_logentries
-            key: use_tls
-      flatten:
-        description: Flatten complex data structures into a single dictionary with complex keys.
-        type: boolean
-        default: false
-        env:
-          - name: LOGENTRIES_FLATTEN
-        ini:
-          - section: callback_logentries
-            key: flatten
-'''
+      - Toggle to decide whether to use TLS to encrypt the communications with the API server.
+    env:
+      - name: LOGENTRIES_USE_TLS
+    default: false
+    type: boolean
+    ini:
+      - section: callback_logentries
+        key: use_tls
+  flatten:
+    description: Flatten complex data structures into a single dictionary with complex keys.
+    type: boolean
+    default: false
+    env:
+      - name: LOGENTRIES_FLATTEN
+    ini:
+      - section: callback_logentries
+        key: flatten
+"""
 
-EXAMPLES = '''
-examples: >
+EXAMPLES = r"""
+examples: >-
   To enable, add this to your ansible.cfg file in the defaults block
 
     [defaults]
@@ -97,7 +95,7 @@ examples: >
     use_tls = true
     token = dd21fc88-f00a-43ff-b977-e3a4233c53af
     flatten = false
-'''
+"""
 
 import os
 import socket

plugins/callback/logstash.py

@@ -7,95 +7,94 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = r'''
-    author: Yevhen Khmelenko (@ujenmr)
-    name: logstash
-    type: notification
-    short_description: Sends events to Logstash
-    description:
-      - This callback will report facts and task events to Logstash U(https://www.elastic.co/products/logstash).
-    requirements:
-      - whitelisting in configuration
-      - logstash (Python library)
-    options:
-      server:
-        description: Address of the Logstash server.
-        type: str
-        env:
-          - name: LOGSTASH_SERVER
-        ini:
-          - section: callback_logstash
-            key: server
-            version_added: 1.0.0
-        default: localhost
-      port:
-        description: Port on which logstash is listening.
-        type: int
-        env:
-            - name: LOGSTASH_PORT
-        ini:
-          - section: callback_logstash
-            key: port
-            version_added: 1.0.0
-        default: 5000
-      type:
-        description: Message type.
-        type: str
-        env:
-          - name: LOGSTASH_TYPE
-        ini:
-          - section: callback_logstash
-            key: type
-            version_added: 1.0.0
-        default: ansible
-      pre_command:
-        description: Executes command before run and its result is added to the C(ansible_pre_command_output) logstash field.
-        type: str
-        version_added: 2.0.0
-        ini:
-          - section: callback_logstash
-            key: pre_command
-        env:
-          - name: LOGSTASH_PRE_COMMAND
-      format_version:
-        description: Logging format.
-        type: str
-        version_added: 2.0.0
-        ini:
-          - section: callback_logstash
-            key: format_version
-        env:
-          - name: LOGSTASH_FORMAT_VERSION
-        default: v1
-        choices:
-          - v1
-          - v2
+DOCUMENTATION = r"""
+author: Yevhen Khmelenko (@ujenmr)
+name: logstash
+type: notification
+short_description: Sends events to Logstash
+description:
+  - This callback will report facts and task events to Logstash U(https://www.elastic.co/products/logstash).
+requirements:
+  - whitelisting in configuration
+  - logstash (Python library)
+options:
+  server:
+    description: Address of the Logstash server.
+    type: str
+    env:
+      - name: LOGSTASH_SERVER
+    ini:
+      - section: callback_logstash
+        key: server
+        version_added: 1.0.0
+    default: localhost
+  port:
+    description: Port on which logstash is listening.
+    type: int
+    env:
+      - name: LOGSTASH_PORT
+    ini:
+      - section: callback_logstash
+        key: port
+        version_added: 1.0.0
+    default: 5000
+  type:
+    description: Message type.
+    type: str
+    env:
+      - name: LOGSTASH_TYPE
+    ini:
+      - section: callback_logstash
+        key: type
+        version_added: 1.0.0
+    default: ansible
+  pre_command:
+    description: Executes command before run and its result is added to the C(ansible_pre_command_output) logstash field.
+    type: str
+    version_added: 2.0.0
+    ini:
+      - section: callback_logstash
+        key: pre_command
+    env:
+      - name: LOGSTASH_PRE_COMMAND
+  format_version:
+    description: Logging format.
+    type: str
+    version_added: 2.0.0
+    ini:
+      - section: callback_logstash
+        key: format_version
+    env:
+      - name: LOGSTASH_FORMAT_VERSION
+    default: v1
+    choices:
+      - v1
+      - v2
+"""
 
-'''
-
-EXAMPLES = r'''
+EXAMPLES = r"""
 ansible.cfg: |
-    # Enable Callback plugin
-    [defaults]
-        callback_whitelist = community.general.logstash
+  # Enable Callback plugin
+  [defaults]
+      callback_whitelist = community.general.logstash
 
-    [callback_logstash]
-        server = logstash.example.com
-        port = 5000
-        pre_command = git rev-parse HEAD
-        type = ansible
+  [callback_logstash]
+      server = logstash.example.com
+      port = 5000
+      pre_command = git rev-parse HEAD
+      type = ansible
 
-11-input-tcp.conf: |
-    # Enable Logstash TCP Input
-    input {
-            tcp {
-                port => 5000
-                codec => json
-                add_field => { "[@metadata][beat]" => "notify" }
-                add_field => { "[@metadata][type]" => "ansible" }
-            }
-        }
-'''
+11-input-tcp.conf: |-
+  # Enable Logstash TCP Input
+  input {
+          tcp {
+              port => 5000
+              codec => json
+              add_field => { "[@metadata][beat]" => "notify" }
+              add_field => { "[@metadata][type]" => "ansible" }
+          }
+      }
+"""
 
 import os
 import json

plugins/callback/mail.py

@@ -7,81 +7,80 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = '''
+DOCUMENTATION = r"""
 name: mail
 type: notification
-short_description: Sends failure events via email
+short_description: Sends failure events through email
 description:
-- This callback will report failures via email.
+  - This callback will report failures through email.
 author:
-- Dag Wieers (@dagwieers)
+  - Dag Wieers (@dagwieers)
 requirements:
-- whitelisting in configuration
+  - whitelisting in configuration
 options:
   mta:
     description:
-        - Mail Transfer Agent, server that accepts SMTP.
+      - Mail Transfer Agent, server that accepts SMTP.
     type: str
     env:
-        - name: SMTPHOST
+      - name: SMTPHOST
     ini:
-        - section: callback_mail
-          key: smtphost
+      - section: callback_mail
+        key: smtphost
     default: localhost
   mtaport:
     description:
-        - Mail Transfer Agent Port.
-        - Port at which server SMTP.
+      - Mail Transfer Agent Port.
+      - Port at which server SMTP.
     type: int
     ini:
-        - section: callback_mail
-          key: smtpport
+      - section: callback_mail
+        key: smtpport
     default: 25
   to:
     description:
-        - Mail recipient.
+      - Mail recipient.
     type: list
     elements: str
     ini:
-        - section: callback_mail
-          key: to
+      - section: callback_mail
+        key: to
     default: [root]
   sender:
     description:
-        - Mail sender.
-        - This is required since community.general 6.0.0.
+      - Mail sender.
+      - This is required since community.general 6.0.0.
     type: str
     required: true
     ini:
-        - section: callback_mail
-          key: sender
+      - section: callback_mail
+        key: sender
   cc:
     description:
-        - CC'd recipients.
+      - CC'd recipients.
     type: list
     elements: str
     ini:
-        - section: callback_mail
-          key: cc
+      - section: callback_mail
+        key: cc
   bcc:
     description:
-        - BCC'd recipients.
+      - BCC'd recipients.
     type: list
     elements: str
     ini:
-        - section: callback_mail
-          key: bcc
+      - section: callback_mail
+        key: bcc
   message_id_domain:
     description:
-        - The domain name to use for the L(Message-ID header, https://en.wikipedia.org/wiki/Message-ID).
-        - The default is the hostname of the control node.
+      - The domain name to use for the L(Message-ID header, https://en.wikipedia.org/wiki/Message-ID).
+      - The default is the hostname of the control node.
     type: str
     ini:
-        - section: callback_mail
-          key: message_id_domain
+      - section: callback_mail
+        key: message_id_domain
     version_added: 8.2.0
-
-'''
+"""
 
 import json
 import os

plugins/callback/nrdp.py

@@ -7,65 +7,65 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = '''
-    name: nrdp
-    type: notification
-    author: "Remi VERCHERE (@rverchere)"
-    short_description: Post task results to a Nagios server through nrdp
-    description:
-        - This callback send playbook result to Nagios.
-        - Nagios shall use NRDP to receive passive events.
-        - The passive check is sent to a dedicated host/service for Ansible.
-    options:
-        url:
-            description: URL of the nrdp server.
-            required: true
-            env:
-                - name : NRDP_URL
-            ini:
-                - section: callback_nrdp
-                  key: url
-            type: string
-        validate_certs:
-            description: Validate the SSL certificate of the nrdp server. (Used for HTTPS URLs.)
-            env:
-                - name: NRDP_VALIDATE_CERTS
-            ini:
-                - section: callback_nrdp
-                  key: validate_nrdp_certs
-                - section: callback_nrdp
-                  key: validate_certs
-            type: boolean
-            default: false
-            aliases: [ validate_nrdp_certs ]
-        token:
-            description: Token to be allowed to push nrdp events.
-            required: true
-            env:
-                - name: NRDP_TOKEN
-            ini:
-                - section: callback_nrdp
-                  key: token
-            type: string
-        hostname:
-            description: Hostname where the passive check is linked to.
-            required: true
-            env:
-                - name : NRDP_HOSTNAME
-            ini:
-                - section: callback_nrdp
-                  key: hostname
-            type: string
-        servicename:
-            description: Service where the passive check is linked to.
-            required: true
-            env:
-                - name : NRDP_SERVICENAME
-            ini:
-                - section: callback_nrdp
-                  key: servicename
-            type: string
-'''
+DOCUMENTATION = r"""
+name: nrdp
+type: notification
+author: "Remi VERCHERE (@rverchere)"
+short_description: Post task results to a Nagios server through nrdp
+description:
+  - This callback send playbook result to Nagios.
+  - Nagios shall use NRDP to receive passive events.
+  - The passive check is sent to a dedicated host/service for Ansible.
+options:
+  url:
+    description: URL of the nrdp server.
+    required: true
+    env:
+      - name: NRDP_URL
+    ini:
+      - section: callback_nrdp
+        key: url
+    type: string
+  validate_certs:
+    description: Validate the SSL certificate of the nrdp server. (Used for HTTPS URLs).
+    env:
+      - name: NRDP_VALIDATE_CERTS
+    ini:
+      - section: callback_nrdp
+        key: validate_nrdp_certs
+      - section: callback_nrdp
+        key: validate_certs
+    type: boolean
+    default: false
+    aliases: [validate_nrdp_certs]
+  token:
+    description: Token to be allowed to push nrdp events.
+    required: true
+    env:
+      - name: NRDP_TOKEN
+    ini:
+      - section: callback_nrdp
+        key: token
+    type: string
+  hostname:
+    description: Hostname where the passive check is linked to.
+    required: true
+    env:
+      - name: NRDP_HOSTNAME
+    ini:
+      - section: callback_nrdp
+        key: hostname
+    type: string
+  servicename:
+    description: Service where the passive check is linked to.
+    required: true
+    env:
+      - name: NRDP_SERVICENAME
+    ini:
+      - section: callback_nrdp
+        key: servicename
+    type: string
+"""
 
 from ansible.module_utils.six.moves.urllib.parse import urlencode
 from ansible.module_utils.common.text.converters import to_bytes

plugins/callback/null.py

@@ -7,16 +7,16 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = '''
-    author: Unknown (!UNKNOWN)
-    name: 'null'
-    type: stdout
-    requirements:
-      - set as main display callback
-    short_description: Don't display stuff to screen
-    description:
-        - This callback prevents outputting events to screen.
-'''
+DOCUMENTATION = r"""
+author: Unknown (!UNKNOWN)
+name: 'null'
+type: stdout
+requirements:
+  - set as main display callback
+short_description: do not display stuff to screen
+description:
+  - This callback prevents outputting events to screen.
+"""
 
 from ansible.plugins.callback import CallbackBase
 

plugins/callback/opentelemetry.py

@@ -6,119 +6,120 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = '''
-    author: Victor Martinez (@v1v)  <VictorMartinezRubio@gmail.com>
-    name: opentelemetry
-    type: notification
-    short_description: Create distributed traces with OpenTelemetry
-    version_added: 3.7.0
+DOCUMENTATION = r"""
+author: Victor Martinez (@v1v)  <VictorMartinezRubio@gmail.com>
+name: opentelemetry
+type: notification
+short_description: Create distributed traces with OpenTelemetry
+version_added: 3.7.0
+description:
+  - This callback creates distributed traces for each Ansible task with OpenTelemetry.
+  - You can configure the OpenTelemetry exporter and SDK with environment variables.
+  - See U(https://opentelemetry-python.readthedocs.io/en/latest/exporter/otlp/otlp.html).
+  - See
+    U(https://opentelemetry-python.readthedocs.io/en/latest/sdk/environment_variables.html#opentelemetry-sdk-environment-variables).
+options:
+  hide_task_arguments:
+    default: false
+    type: bool
     description:
-      - This callback creates distributed traces for each Ansible task with OpenTelemetry.
-      - You can configure the OpenTelemetry exporter and SDK with environment variables.
-      - See U(https://opentelemetry-python.readthedocs.io/en/latest/exporter/otlp/otlp.html).
-      - See U(https://opentelemetry-python.readthedocs.io/en/latest/sdk/environment_variables.html#opentelemetry-sdk-environment-variables).
-    options:
-      hide_task_arguments:
-        default: false
-        type: bool
-        description:
-          - Hide the arguments for a task.
-        env:
-          - name: ANSIBLE_OPENTELEMETRY_HIDE_TASK_ARGUMENTS
-        ini:
-          - section: callback_opentelemetry
-            key: hide_task_arguments
-            version_added: 5.3.0
-      enable_from_environment:
-        type: str
-        description:
-          - Whether to enable this callback only if the given environment variable exists and it is set to V(true).
-          - This is handy when you use Configuration as Code and want to send distributed traces
-            if running in the CI rather when running Ansible locally.
-          - For such, it evaluates the given O(enable_from_environment) value as environment variable
-            and if set to true this plugin will be enabled.
-        env:
-          - name: ANSIBLE_OPENTELEMETRY_ENABLE_FROM_ENVIRONMENT
-        ini:
-          - section: callback_opentelemetry
-            key: enable_from_environment
-            version_added: 5.3.0
-        version_added: 3.8.0
-      otel_service_name:
-        default: ansible
-        type: str
-        description:
-          - The service name resource attribute.
-        env:
-          - name: OTEL_SERVICE_NAME
-        ini:
-          - section: callback_opentelemetry
-            key: otel_service_name
-            version_added: 5.3.0
-      traceparent:
-        default: None
-        type: str
-        description:
-          - The L(W3C Trace Context header traceparent,https://www.w3.org/TR/trace-context-1/#traceparent-header).
-        env:
-          - name: TRACEPARENT
-      disable_logs:
-        default: false
-        type: bool
-        description:
-          - Disable sending logs.
-        env:
-          - name: ANSIBLE_OPENTELEMETRY_DISABLE_LOGS
-        ini:
-          - section: callback_opentelemetry
-            key: disable_logs
-        version_added: 5.8.0
-      disable_attributes_in_logs:
-        default: false
-        type: bool
-        description:
-          - Disable populating span attributes to the logs.
-        env:
-          - name: ANSIBLE_OPENTELEMETRY_DISABLE_ATTRIBUTES_IN_LOGS
-        ini:
-          - section: callback_opentelemetry
-            key: disable_attributes_in_logs
-        version_added: 7.1.0
-      store_spans_in_file:
-        type: str
-        description:
-          -  It stores the exported spans in the given file
-        env:
-          - name: ANSIBLE_OPENTELEMETRY_STORE_SPANS_IN_FILE
-        ini:
-          - section: callback_opentelemetry
-            key: store_spans_in_file
-        version_added: 9.0.0
-      otel_exporter_otlp_traces_protocol:
-        type: str
-        description:
-          - E(OTEL_EXPORTER_OTLP_TRACES_PROTOCOL) represents the the transport protocol for spans.
-          - See
-            U(https://opentelemetry-python.readthedocs.io/en/latest/sdk/environment_variables.html#envvar-OTEL_EXPORTER_OTLP_TRACES_PROTOCOL).
-        default: grpc
-        choices:
-          - grpc
-          - http/protobuf
-        env:
-          - name: OTEL_EXPORTER_OTLP_TRACES_PROTOCOL
-        ini:
-          - section: callback_opentelemetry
-            key: otel_exporter_otlp_traces_protocol
-        version_added: 9.0.0
-    requirements:
-      - opentelemetry-api (Python library)
-      - opentelemetry-exporter-otlp (Python library)
-      - opentelemetry-sdk (Python library)
-'''
+      - Hide the arguments for a task.
+    env:
+      - name: ANSIBLE_OPENTELEMETRY_HIDE_TASK_ARGUMENTS
+    ini:
+      - section: callback_opentelemetry
+        key: hide_task_arguments
+        version_added: 5.3.0
+  enable_from_environment:
+    type: str
+    description:
+      - Whether to enable this callback only if the given environment variable exists and it is set to V(true).
+      - This is handy when you use Configuration as Code and want to send distributed traces if running in the CI rather when
+        running Ansible locally.
+      - For such, it evaluates the given O(enable_from_environment) value as environment variable and if set to true this
+        plugin will be enabled.
+    env:
+      - name: ANSIBLE_OPENTELEMETRY_ENABLE_FROM_ENVIRONMENT
+    ini:
+      - section: callback_opentelemetry
+        key: enable_from_environment
+        version_added: 5.3.0
+    version_added: 3.8.0
+  otel_service_name:
+    default: ansible
+    type: str
+    description:
+      - The service name resource attribute.
+    env:
+      - name: OTEL_SERVICE_NAME
+    ini:
+      - section: callback_opentelemetry
+        key: otel_service_name
+        version_added: 5.3.0
+  traceparent:
+    default: None
+    type: str
+    description:
+      - The L(W3C Trace Context header traceparent,https://www.w3.org/TR/trace-context-1/#traceparent-header).
+    env:
+      - name: TRACEPARENT
+  disable_logs:
+    default: false
+    type: bool
+    description:
+      - Disable sending logs.
+    env:
+      - name: ANSIBLE_OPENTELEMETRY_DISABLE_LOGS
+    ini:
+      - section: callback_opentelemetry
+        key: disable_logs
+    version_added: 5.8.0
+  disable_attributes_in_logs:
+    default: false
+    type: bool
+    description:
+      - Disable populating span attributes to the logs.
+    env:
+      - name: ANSIBLE_OPENTELEMETRY_DISABLE_ATTRIBUTES_IN_LOGS
+    ini:
+      - section: callback_opentelemetry
+        key: disable_attributes_in_logs
+    version_added: 7.1.0
+  store_spans_in_file:
+    type: str
+    description:
+      - It stores the exported spans in the given file.
+    env:
+      - name: ANSIBLE_OPENTELEMETRY_STORE_SPANS_IN_FILE
+    ini:
+      - section: callback_opentelemetry
+        key: store_spans_in_file
+    version_added: 9.0.0
+  otel_exporter_otlp_traces_protocol:
+    type: str
+    description:
+      - E(OTEL_EXPORTER_OTLP_TRACES_PROTOCOL) represents the the transport protocol for spans.
+      - See
+        U(https://opentelemetry-python.readthedocs.io/en/latest/sdk/environment_variables.html#envvar-OTEL_EXPORTER_OTLP_TRACES_PROTOCOL).
+    default: grpc
+    choices:
+      - grpc
+      - http/protobuf
+    env:
+      - name: OTEL_EXPORTER_OTLP_TRACES_PROTOCOL
+    ini:
+      - section: callback_opentelemetry
+        key: otel_exporter_otlp_traces_protocol
+    version_added: 9.0.0
+requirements:
+  - opentelemetry-api (Python library)
+  - opentelemetry-exporter-otlp (Python library)
+  - opentelemetry-sdk (Python library)
+"""
 
 
-EXAMPLES = '''
-examples: |
+EXAMPLES = r"""
+examples: |-
   Enable the plugin in ansible.cfg:
     [defaults]
     callbacks_enabled = community.general.opentelemetry
@@ -130,7 +131,7 @@ examples: |
     export OTEL_EXPORTER_OTLP_HEADERS="authorization=Bearer your_otel_token"
     export OTEL_SERVICE_NAME=your_service_name
     export ANSIBLE_OPENTELEMETRY_ENABLED=true
-'''
+"""
 
 import getpass
 import json

plugins/callback/say.py

@@ -8,17 +8,17 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = '''
-    author: Unknown (!UNKNOWN)
-    name: say
-    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
-    description:
-      - This plugin will use the C(say) or C(espeak) program to "speak" about play events.
-'''
+DOCUMENTATION = r"""
+author: Unknown (!UNKNOWN)
+name: say
+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
+description:
+  - This plugin will use the C(say) or C(espeak) program to "speak" about play events.
+"""
 
 import platform
 import subprocess

plugins/callback/selective.py

@@ -7,35 +7,35 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = '''
-    author: Unknown (!UNKNOWN)
-    name: selective
-    type: stdout
-    requirements:
-      - set as main display callback
-    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.
-      - Tasks that are not printed are placed with a C(.).
-      - If you increase verbosity all tasks are printed.
-    options:
-      nocolor:
-        default: false
-        description: This setting allows suppressing colorizing output.
-        env:
-          - name: ANSIBLE_NOCOLOR
-          - name: ANSIBLE_SELECTIVE_DONT_COLORIZE
-        ini:
-          - section: defaults
-            key: nocolor
-        type: boolean
-'''
+DOCUMENTATION = r"""
+author: Unknown (!UNKNOWN)
+name: selective
+type: stdout
+requirements:
+  - set as main display callback
+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.
+  - Tasks that are not printed are placed with a C(.).
+  - If you increase verbosity all tasks are printed.
+options:
+  nocolor:
+    default: false
+    description: This setting allows suppressing colorizing output.
+    env:
+      - name: ANSIBLE_NOCOLOR
+      - name: ANSIBLE_SELECTIVE_DONT_COLORIZE
+    ini:
+      - section: defaults
+        key: nocolor
+    type: boolean
+"""
 
-EXAMPLES = """
-  - ansible.builtin.debug: msg="This will not be printed"
-  - ansible.builtin.debug: msg="But this will"
-    tags: [print_action]
+EXAMPLES = r"""
+- ansible.builtin.debug: msg="This will not be printed"
+- ansible.builtin.debug: msg="But this will"
+  tags: [print_action]
 """
 
 import difflib

plugins/callback/slack.py

@@ -8,54 +8,54 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = '''
-    author: Unknown (!UNKNOWN)
-    name: slack
-    type: notification
-    requirements:
-      - whitelist in configuration
-      - prettytable (python library)
-    short_description: Sends play events to a Slack channel
-    description:
-        - This is an ansible callback plugin that sends status updates to a Slack channel during playbook execution.
-    options:
-      webhook_url:
-        required: true
-        description: Slack Webhook URL.
-        type: str
-        env:
-          - name: SLACK_WEBHOOK_URL
-        ini:
-          - section: callback_slack
-            key: webhook_url
-      channel:
-        default: "#ansible"
-        description: Slack room to post in.
-        type: str
-        env:
-          - name: SLACK_CHANNEL
-        ini:
-          - section: callback_slack
-            key: channel
-      username:
-        description: Username to post as.
-        type: str
-        env:
-          - name: SLACK_USERNAME
-        default: ansible
-        ini:
-          - section: callback_slack
-            key: username
-      validate_certs:
-        description: Validate the SSL certificate of the Slack server for HTTPS URLs.
-        env:
-          - name: SLACK_VALIDATE_CERTS
-        ini:
-          - section: callback_slack
-            key: validate_certs
-        default: true
-        type: bool
-'''
+DOCUMENTATION = r"""
+author: Unknown (!UNKNOWN)
+name: slack
+type: notification
+requirements:
+  - whitelist in configuration
+  - prettytable (python library)
+short_description: Sends play events to a Slack channel
+description:
+  - This is an ansible callback plugin that sends status updates to a Slack channel during playbook execution.
+options:
+  webhook_url:
+    required: true
+    description: Slack Webhook URL.
+    type: str
+    env:
+      - name: SLACK_WEBHOOK_URL
+    ini:
+      - section: callback_slack
+        key: webhook_url
+  channel:
+    default: "#ansible"
+    description: Slack room to post in.
+    type: str
+    env:
+      - name: SLACK_CHANNEL
+    ini:
+      - section: callback_slack
+        key: channel
+  username:
+    description: Username to post as.
+    type: str
+    env:
+      - name: SLACK_USERNAME
+    default: ansible
+    ini:
+      - section: callback_slack
+        key: username
+  validate_certs:
+    description: Validate the SSL certificate of the Slack server for HTTPS URLs.
+    env:
+      - name: SLACK_VALIDATE_CERTS
+    ini:
+      - section: callback_slack
+        key: validate_certs
+    default: true
+    type: bool
+"""
 
 import json
 import os

plugins/callback/splunk.py

@@ -6,73 +6,73 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = '''
-    name: splunk
-    type: notification
-    short_description: Sends task result events to Splunk HTTP Event Collector
-    author: "Stuart Hirst (!UNKNOWN) <support@convergingdata.com>"
+DOCUMENTATION = r"""
+name: splunk
+type: notification
+short_description: Sends task result events to Splunk HTTP Event Collector
+author: "Stuart Hirst (!UNKNOWN) <support@convergingdata.com>"
+description:
+  - This callback plugin will send task results as JSON formatted events to a Splunk HTTP collector.
+  - The companion Splunk Monitoring & Diagnostics App is available here U(https://splunkbase.splunk.com/app/4023/).
+  - Credit to "Ryan Currah (@ryancurrah)" for original source upon which this is based.
+requirements:
+  - Whitelisting this callback plugin
+  - 'Create a HTTP Event Collector in Splunk'
+  - 'Define the URL and token in C(ansible.cfg)'
+options:
+  url:
+    description: URL to the Splunk HTTP collector source.
+    type: str
+    env:
+      - name: SPLUNK_URL
+    ini:
+      - section: callback_splunk
+        key: url
+  authtoken:
+    description: Token to authenticate the connection to the Splunk HTTP collector.
+    type: str
+    env:
+      - name: SPLUNK_AUTHTOKEN
+    ini:
+      - section: callback_splunk
+        key: authtoken
+  validate_certs:
+    description: Whether to validate certificates for connections to HEC. It is not recommended to set to V(false) except
+      when you are sure that nobody can intercept the connection between this plugin and HEC, as setting it to V(false) allows
+      man-in-the-middle attacks!
+    env:
+      - name: SPLUNK_VALIDATE_CERTS
+    ini:
+      - section: callback_splunk
+        key: validate_certs
+    type: bool
+    default: true
+    version_added: '1.0.0'
+  include_milliseconds:
+    description: Whether to include milliseconds as part of the generated timestamp field in the event sent to the Splunk
+      HTTP collector.
+    env:
+      - name: SPLUNK_INCLUDE_MILLISECONDS
+    ini:
+      - section: callback_splunk
+        key: include_milliseconds
+    type: bool
+    default: false
+    version_added: 2.0.0
+  batch:
     description:
-      - This callback plugin will send task results as JSON formatted events to a Splunk HTTP collector.
-      - The companion Splunk Monitoring & Diagnostics App is available here U(https://splunkbase.splunk.com/app/4023/).
-      - Credit to "Ryan Currah (@ryancurrah)" for original source upon which this is based.
-    requirements:
-      - Whitelisting this callback plugin
-      - 'Create a HTTP Event Collector in Splunk'
-      - 'Define the URL and token in C(ansible.cfg)'
-    options:
-      url:
-        description: URL to the Splunk HTTP collector source.
-        type: str
-        env:
-          - name: SPLUNK_URL
-        ini:
-          - section: callback_splunk
-            key: url
-      authtoken:
-        description: Token to authenticate the connection to the Splunk HTTP collector.
-        type: str
-        env:
-          - name: SPLUNK_AUTHTOKEN
-        ini:
-          - section: callback_splunk
-            key: authtoken
-      validate_certs:
-        description: Whether to validate certificates for connections to HEC. It is not recommended to set to
-                     V(false) except when you are sure that nobody can intercept the connection
-                     between this plugin and HEC, as setting it to V(false) allows man-in-the-middle attacks!
-        env:
-          - name: SPLUNK_VALIDATE_CERTS
-        ini:
-          - section: callback_splunk
-            key: validate_certs
-        type: bool
-        default: true
-        version_added: '1.0.0'
-      include_milliseconds:
-        description: Whether to include milliseconds as part of the generated timestamp field in the event
-                     sent to the Splunk HTTP collector.
-        env:
-          - name: SPLUNK_INCLUDE_MILLISECONDS
-        ini:
-          - section: callback_splunk
-            key: include_milliseconds
-        type: bool
-        default: false
-        version_added: 2.0.0
-      batch:
-        description:
-          - Correlation ID which can be set across multiple playbook executions.
-        env:
-          - name: SPLUNK_BATCH
-        ini:
-          - section: callback_splunk
-            key: batch
-        type: str
-        version_added: 3.3.0
-'''
+      - Correlation ID which can be set across multiple playbook executions.
+    env:
+      - name: SPLUNK_BATCH
+    ini:
+      - section: callback_splunk
+        key: batch
+    type: str
+    version_added: 3.3.0
+"""
 
-EXAMPLES = '''
-examples: >
+EXAMPLES = r"""
+examples: >-
   To enable, add this to your ansible.cfg file in the defaults block
     [defaults]
     callback_whitelist = community.general.splunk
@@ -83,7 +83,7 @@ examples: >
     [callback_splunk]
     url = http://mysplunkinstance.datapaas.io:8088/services/collector/event
     authtoken = f23blad6-5965-4537-bf69-5b5a545blabla88
-'''
+"""
 
 import json
 import uuid

plugins/callback/sumologic.py

@@ -6,7 +6,7 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = r'''
+DOCUMENTATION = r"""
 name: sumologic
 type: notification
 short_description: Sends task result events to Sumologic
@@ -15,8 +15,8 @@ description:
   - This callback plugin will send task results as JSON formatted events to a Sumologic HTTP collector source.
 requirements:
   - Whitelisting this callback plugin
-  - 'Create a HTTP collector source in Sumologic and specify a custom timestamp format of V(yyyy-MM-dd HH:mm:ss ZZZZ) and a custom timestamp locator
-    of V("timestamp": "(.*\)")'
+  - 'Create a HTTP collector source in Sumologic and specify a custom timestamp format of V(yyyy-MM-dd HH:mm:ss ZZZZ) and
+    a custom timestamp locator of V("timestamp": "(.*\)")'
 options:
   url:
     description: URL to the Sumologic HTTP collector source.
@@ -26,10 +26,10 @@ options:
     ini:
       - section: callback_sumologic
         key: url
-'''
+"""
 
-EXAMPLES = '''
-examples: |
+EXAMPLES = r"""
+examples: |-
   To enable, add this to your ansible.cfg file in the defaults block
     [defaults]
     callback_whitelist = community.general.sumologic
@@ -40,7 +40,7 @@ examples: |
   Set the ansible.cfg variable in the callback_sumologic block
     [callback_sumologic]
     url = https://endpoint1.collection.us2.sumologic.com/receiver/v1/http/R8moSv1d8EW9LAUFZJ6dbxCFxwLH6kfCdcBfddlfxCbLuL-BN5twcTpMk__pYy_cDmp==
-'''
+"""
 
 import json
 import uuid

plugins/callback/syslog_json.py

@@ -7,54 +7,54 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = '''
-    author: Unknown (!UNKNOWN)
-    name: syslog_json
-    type: notification
-    requirements:
-      - whitelist in configuration
-    short_description: sends JSON events to syslog
-    description:
-      - This plugin logs ansible-playbook and ansible runs to a syslog server in JSON format.
-    options:
-      server:
-        description: Syslog server that will receive the event.
-        type: str
-        env:
-        - name: SYSLOG_SERVER
-        default: localhost
-        ini:
-          - section: callback_syslog_json
-            key: syslog_server
-      port:
-        description: Port on which the syslog server is listening.
-        type: int
-        env:
-          - name: SYSLOG_PORT
-        default: 514
-        ini:
-          - section: callback_syslog_json
-            key: syslog_port
-      facility:
-        description: Syslog facility to log as.
-        type: str
-        env:
-          - name: SYSLOG_FACILITY
-        default: user
-        ini:
-          - section: callback_syslog_json
-            key: syslog_facility
-      setup:
-        description: Log setup tasks.
-        env:
-          - name: ANSIBLE_SYSLOG_SETUP
-        type: bool
-        default: true
-        ini:
-          - section: callback_syslog_json
-            key: syslog_setup
-        version_added: 4.5.0
-'''
+DOCUMENTATION = r"""
+author: Unknown (!UNKNOWN)
+name: syslog_json
+type: notification
+requirements:
+  - whitelist in configuration
+short_description: sends JSON events to syslog
+description:
+  - This plugin logs ansible-playbook and ansible runs to a syslog server in JSON format.
+options:
+  server:
+    description: Syslog server that will receive the event.
+    type: str
+    env:
+      - name: SYSLOG_SERVER
+    default: localhost
+    ini:
+      - section: callback_syslog_json
+        key: syslog_server
+  port:
+    description: Port on which the syslog server is listening.
+    type: int
+    env:
+      - name: SYSLOG_PORT
+    default: 514
+    ini:
+      - section: callback_syslog_json
+        key: syslog_port
+  facility:
+    description: Syslog facility to log as.
+    type: str
+    env:
+      - name: SYSLOG_FACILITY
+    default: user
+    ini:
+      - section: callback_syslog_json
+        key: syslog_facility
+  setup:
+    description: Log setup tasks.
+    env:
+      - name: ANSIBLE_SYSLOG_SETUP
+    type: bool
+    default: true
+    ini:
+      - section: callback_syslog_json
+        key: syslog_setup
+    version_added: 4.5.0
+"""
 
 import logging
 import logging.handlers

plugins/callback/timestamp.py

@@ -10,46 +10,45 @@ from __future__ import absolute_import, division, print_function
 __metaclass__ = type
 
 DOCUMENTATION = r"""
-  name: timestamp
-  type: stdout
-  short_description: Adds simple timestamp for each header
-  version_added: 9.0.0
-  description:
-    - This callback adds simple timestamp for each header.
-  author: kurokobo (@kurokobo)
-  options:
-    timezone:
-      description:
-        - Timezone to use for the timestamp in IANA time zone format.
-        - For example C(America/New_York), C(Asia/Tokyo)). Ignored on Python < 3.9.
-      ini:
-        - section: callback_timestamp
-          key: timezone
-      env:
-        - name: ANSIBLE_CALLBACK_TIMESTAMP_TIMEZONE
-      type: string
-    format_string:
-      description:
-        - Format of the timestamp shown to user in 1989 C standard format.
-        - >
-          Refer to L(the Python documentation,https://docs.python.org/3/library/datetime.html#strftime-and-strptime-format-codes)
-          for the available format codes.
-      ini:
-        - section: callback_timestamp
-          key: format_string
-      env:
-        - name: ANSIBLE_CALLBACK_TIMESTAMP_FORMAT_STRING
-      default: "%H:%M:%S"
-      type: string
-  seealso:
-    - plugin: ansible.posix.profile_tasks
-      plugin_type: callback
-      description: >
-        You can use P(ansible.posix.profile_tasks#callback) callback plugin to time individual tasks and overall execution time
-        with detailed timestamps.
-  extends_documentation_fragment:
-    - ansible.builtin.default_callback
-    - ansible.builtin.result_format_callback
+name: timestamp
+type: stdout
+short_description: Adds simple timestamp for each header
+version_added: 9.0.0
+description:
+  - This callback adds simple timestamp for each header.
+author: kurokobo (@kurokobo)
+options:
+  timezone:
+    description:
+      - Timezone to use for the timestamp in IANA time zone format.
+      - For example V(America/New_York), V(Asia/Tokyo)). Ignored on Python < 3.9.
+    ini:
+      - section: callback_timestamp
+        key: timezone
+    env:
+      - name: ANSIBLE_CALLBACK_TIMESTAMP_TIMEZONE
+    type: string
+  format_string:
+    description:
+      - Format of the timestamp shown to user in 1989 C standard format.
+      - Refer to L(the Python documentation,https://docs.python.org/3/library/datetime.html#strftime-and-strptime-format-codes)
+        for the available format codes.
+    ini:
+      - section: callback_timestamp
+        key: format_string
+    env:
+      - name: ANSIBLE_CALLBACK_TIMESTAMP_FORMAT_STRING
+    default: "%H:%M:%S"
+    type: string
+seealso:
+  - plugin: ansible.posix.profile_tasks
+    plugin_type: callback
+    description: >-
+      You can use P(ansible.posix.profile_tasks#callback) callback plugin to time individual tasks and overall execution time
+      with detailed timestamps.
+extends_documentation_fragment:
+  - ansible.builtin.default_callback
+  - ansible.builtin.result_format_callback
 """
 
 

plugins/callback/unixy.py

@@ -8,18 +8,18 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = '''
-    name: unixy
-    type: stdout
-    author: Al Bowles (@akatch)
-    short_description: condensed Ansible output
-    description:
-      - Consolidated Ansible output in the style of LINUX/UNIX startup logs.
-    extends_documentation_fragment:
-      - default_callback
-    requirements:
-      - set as stdout in configuration
-'''
+DOCUMENTATION = r"""
+name: unixy
+type: stdout
+author: Al Bowles (@akatch)
+short_description: condensed Ansible output
+description:
+  - Consolidated Ansible output in the style of LINUX/UNIX startup logs.
+extends_documentation_fragment:
+  - default_callback
+requirements:
+  - set as stdout in configuration
+"""
 
 from os.path import basename
 from ansible import constants as C

plugins/callback/yaml.py

@@ -7,29 +7,27 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = '''
-    author: Unknown (!UNKNOWN)
-    name: yaml
-    type: stdout
-    short_description: YAML-ized Ansible screen output
-    description:
-        - Ansible output that can be quite a bit easier to read than the
-          default JSON formatting.
-    extends_documentation_fragment:
-      - default_callback
-    requirements:
-      - set as stdout in configuration
-    seealso:
-      - plugin: ansible.builtin.default
-        plugin_type: callback
-        description: >
-          There is a parameter O(ansible.builtin.default#callback:result_format) in P(ansible.builtin.default#callback)
-          that allows you to change the output format to YAML.
-    notes:
-      - >
-        With ansible-core 2.13 or newer, you can instead specify V(yaml) for the parameter O(ansible.builtin.default#callback:result_format)
-        in P(ansible.builtin.default#callback).
-'''
+DOCUMENTATION = r"""
+author: Unknown (!UNKNOWN)
+name: yaml
+type: stdout
+short_description: YAML-ized Ansible screen output
+description:
+  - Ansible output that can be quite a bit easier to read than the default JSON formatting.
+extends_documentation_fragment:
+  - default_callback
+requirements:
+  - set as stdout in configuration
+seealso:
+  - plugin: ansible.builtin.default
+    plugin_type: callback
+    description: >-
+      There is a parameter O(ansible.builtin.default#callback:result_format) in P(ansible.builtin.default#callback) that allows
+      you to change the output format to YAML.
+notes:
+  - With ansible-core 2.13 or newer, you can instead specify V(yaml) for the parameter O(ansible.builtin.default#callback:result_format)
+    in P(ansible.builtin.default#callback).
+"""
 
 import yaml
 import json

plugins/connection/chroot.py

@@ -10,79 +10,66 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = '''
-    author: Maykel Moya (!UNKNOWN) <mmoya@speedyrails.com>
-    name: chroot
-    short_description: Interact with local chroot
+DOCUMENTATION = r"""
+author: Maykel Moya (!UNKNOWN) <mmoya@speedyrails.com>
+name: chroot
+short_description: Interact with local chroot
+description:
+  - Run commands or put/fetch files to an existing chroot on the Ansible controller.
+options:
+  remote_addr:
     description:
-        - Run commands or put/fetch files to an existing chroot on the Ansible controller.
-    options:
-      remote_addr:
-        description:
-            - The path of the chroot you want to access.
-        type: string
-        default: inventory_hostname
-        vars:
-            - name: inventory_hostname
-            - name: ansible_host
-      executable:
-        description:
-            - User specified executable shell
-        type: string
-        ini:
-          - section: defaults
-            key: executable
-        env:
-          - name: ANSIBLE_EXECUTABLE
-        vars:
-          - name: ansible_executable
-        default: /bin/sh
-      chroot_exe:
-        description:
-            - User specified chroot binary
-        type: string
-        ini:
-          - section: chroot_connection
-            key: exe
-        env:
-          - name: ANSIBLE_CHROOT_EXE
-        vars:
-          - name: ansible_chroot_exe
-        default: chroot
-      disable_root_check:
-        description:
-            - Do not check that the user is not root.
-        ini:
-          - section: chroot_connection
-            key: disable_root_check
-        env:
-          - name: ANSIBLE_CHROOT_DISABLE_ROOT_CHECK
-        vars:
-          - name: ansible_chroot_disable_root_check
-        default: false
-        type: bool
-        version_added: 7.3.0
-'''
+      - The path of the chroot you want to access.
+    type: string
+    default: inventory_hostname
+    vars:
+      - name: inventory_hostname
+      - name: ansible_host
+  executable:
+    description:
+      - User specified executable shell.
+    type: string
+    ini:
+      - section: defaults
+        key: executable
+    env:
+      - name: ANSIBLE_EXECUTABLE
+    vars:
+      - name: ansible_executable
+    default: /bin/sh
+  chroot_exe:
+    description:
+      - User specified chroot binary.
+    type: string
+    ini:
+      - section: chroot_connection
+        key: exe
+    env:
+      - name: ANSIBLE_CHROOT_EXE
+    vars:
+      - name: ansible_chroot_exe
+    default: chroot
+  disable_root_check:
+    description:
+      - Do not check that the user is not root.
+    ini:
+      - section: chroot_connection
+        key: disable_root_check
+    env:
+      - name: ANSIBLE_CHROOT_DISABLE_ROOT_CHECK
+    vars:
+      - name: ansible_chroot_disable_root_check
+    default: false
+    type: bool
+    version_added: 7.3.0
+"""
 
 EXAMPLES = r"""
-# Plugin requires root privileges for chroot, -E preserves your env (and location of ~/.ansible):
-# sudo -E ansible-playbook ...
-#
-# Static inventory file
-# [chroots]
-# /path/to/debootstrap
-# /path/to/feboostrap
-# /path/to/lxc-image
-# /path/to/chroot
-
-# playbook
----
 - hosts: chroots
   connection: community.general.chroot
   tasks:
     - debug:
         msg: "This is coming from chroot environment"
-
 """
 
 import os

plugins/connection/funcd.py

@@ -9,24 +9,24 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = '''
-    author: Michael Scherer (@mscherer) <misc@zarb.org>
-    name: funcd
-    short_description: Use funcd to connect to target
+DOCUMENTATION = r"""
+author: Michael Scherer (@mscherer) <misc@zarb.org>
+name: funcd
+short_description: Use funcd to connect to target
+description:
+  - This transport permits you to use Ansible over Func.
+  - For people who have already setup func and that wish to play with ansible, this permit to move gradually to ansible without
+    having to redo completely the setup of the network.
+options:
+  remote_addr:
     description:
-        - This transport permits you to use Ansible over Func.
-        - For people who have already setup func and that wish to play with ansible,
-          this permit to move gradually to ansible without having to redo completely the setup of the network.
-    options:
-      remote_addr:
-        description:
-            - The path of the chroot you want to access.
-        type: string
-        default: inventory_hostname
-        vars:
-            - name: ansible_host
-            - name: ansible_func_host
-'''
+      - The path of the chroot you want to access.
+    type: string
+    default: inventory_hostname
+    vars:
+      - name: ansible_host
+      - name: ansible_func_host
+"""
 
 HAVE_FUNC = False
 try:

plugins/connection/incus.py

@@ -8,47 +8,47 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = """
-    author: Stéphane Graber (@stgraber)
-    name: incus
-    short_description: Run tasks in Incus instances via the Incus CLI.
+DOCUMENTATION = r"""
+author: Stéphane Graber (@stgraber)
+name: incus
+short_description: Run tasks in Incus instances using the Incus CLI
+description:
+  - Run commands or put/fetch files to an existing Incus instance using Incus CLI.
+version_added: "8.2.0"
+options:
+  remote_addr:
     description:
-        - Run commands or put/fetch files to an existing Incus instance using Incus CLI.
-    version_added: "8.2.0"
-    options:
-      remote_addr:
-        description:
-            - The instance identifier.
-        type: string
-        default: inventory_hostname
-        vars:
-            - name: inventory_hostname
-            - name: ansible_host
-            - name: ansible_incus_host
-      executable:
-        description:
-            - The shell to use for execution inside the instance.
-        type: string
-        default: /bin/sh
-        vars:
-            - name: ansible_executable
-            - name: ansible_incus_executable
-      remote:
-        description:
-            - The name of the Incus remote to use (per C(incus remote list)).
-            - Remotes are used to access multiple servers from a single client.
-        type: string
-        default: local
-        vars:
-            - name: ansible_incus_remote
-      project:
-        description:
-            - The name of the Incus project to use (per C(incus project list)).
-            - Projects are used to divide the instances running on a server.
-        type: string
-        default: default
-        vars:
-            - name: ansible_incus_project
+      - The instance identifier.
+    type: string
+    default: inventory_hostname
+    vars:
+      - name: inventory_hostname
+      - name: ansible_host
+      - name: ansible_incus_host
+  executable:
+    description:
+      - The shell to use for execution inside the instance.
+    type: string
+    default: /bin/sh
+    vars:
+      - name: ansible_executable
+      - name: ansible_incus_executable
+  remote:
+    description:
+      - The name of the Incus remote to use (per C(incus remote list)).
+      - Remotes are used to access multiple servers from a single client.
+    type: string
+    default: local
+    vars:
+      - name: ansible_incus_remote
+  project:
+    description:
+      - The name of the Incus project to use (per C(incus project list)).
+      - Projects are used to divide the instances running on a server.
+    type: string
+    default: default
+    vars:
+      - name: ansible_incus_project
 """
 
 import os

plugins/connection/iocage.py

@@ -10,28 +10,28 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = '''
-    author: Stephan Lohse (!UNKNOWN) <dev-github@ploek.org>
-    name: iocage
-    short_description: Run tasks in iocage jails
+DOCUMENTATION = r"""
+author: Stephan Lohse (!UNKNOWN) <dev-github@ploek.org>
+name: iocage
+short_description: Run tasks in iocage jails
+description:
+  - Run commands or put/fetch files to an existing iocage jail.
+options:
+  remote_addr:
     description:
-        - Run commands or put/fetch files to an existing iocage jail
-    options:
-      remote_addr:
-        description:
-            - Path to the jail
-        type: string
-        vars:
-            - name: ansible_host
-            - name: ansible_iocage_host
-      remote_user:
-        description:
-            - User to execute as inside the jail
-        type: string
-        vars:
-            - name: ansible_user
-            - name: ansible_iocage_user
-'''
+      - Path to the jail.
+    type: string
+    vars:
+      - name: ansible_host
+      - name: ansible_iocage_host
+  remote_user:
+    description:
+      - User to execute as inside the jail.
+    type: string
+    vars:
+      - name: ansible_user
+      - name: ansible_iocage_user
+"""
 
 import subprocess
 

plugins/connection/jail.py

@@ -10,30 +10,30 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = '''
-    author: Ansible Core Team
-    name: jail
-    short_description: Run tasks in jails
+DOCUMENTATION = r"""
+author: Ansible Core Team
+name: jail
+short_description: Run tasks in jails
+description:
+  - Run commands or put/fetch files to an existing jail.
+options:
+  remote_addr:
     description:
-        - Run commands or put/fetch files to an existing jail
-    options:
-      remote_addr:
-        description:
-            - Path to the jail
-        type: string
-        default: inventory_hostname
-        vars:
-            - name: inventory_hostname
-            - name: ansible_host
-            - name: ansible_jail_host
-      remote_user:
-        description:
-            - User to execute as inside the jail
-        type: string
-        vars:
-            - name: ansible_user
-            - name: ansible_jail_user
-'''
+      - Path to the jail.
+    type: string
+    default: inventory_hostname
+    vars:
+      - name: inventory_hostname
+      - name: ansible_host
+      - name: ansible_jail_host
+  remote_user:
+    description:
+      - User to execute as inside the jail.
+    type: string
+    vars:
+      - name: ansible_user
+      - name: ansible_jail_user
+"""
 
 import os
 import os.path

plugins/connection/lxc.py

@@ -7,31 +7,31 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = '''
-    author: Joerg Thalheim (!UNKNOWN) <joerg@higgsboson.tk>
-    name: lxc
-    short_description: Run tasks in lxc containers via lxc python library
+DOCUMENTATION = r"""
+author: Joerg Thalheim (!UNKNOWN) <joerg@higgsboson.tk>
+name: lxc
+short_description: Run tasks in LXC containers using lxc python library
+description:
+  - Run commands or put/fetch files to an existing LXC container using lxc python library.
+options:
+  remote_addr:
     description:
-        - Run commands or put/fetch files to an existing lxc container using lxc python library
-    options:
-      remote_addr:
-        description:
-            - Container identifier
-        type: string
-        default: inventory_hostname
-        vars:
-            - name: inventory_hostname
-            - name: ansible_host
-            - name: ansible_lxc_host
-      executable:
-        default: /bin/sh
-        description:
-            - Shell executable
-        type: string
-        vars:
-            - name: ansible_executable
-            - name: ansible_lxc_executable
-'''
+      - Container identifier.
+    type: string
+    default: inventory_hostname
+    vars:
+      - name: inventory_hostname
+      - name: ansible_host
+      - name: ansible_lxc_host
+  executable:
+    default: /bin/sh
+    description:
+      - Shell executable.
+    type: string
+    vars:
+      - name: ansible_executable
+      - name: ansible_lxc_executable
+"""
 
 import os
 import shutil

plugins/connection/lxd.py

@@ -7,48 +7,48 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = '''
-    author: Matt Clay (@mattclay) <matt@mystile.com>
-    name: lxd
-    short_description: Run tasks in LXD instances via C(lxc) CLI
+DOCUMENTATION = r"""
+author: Matt Clay (@mattclay) <matt@mystile.com>
+name: lxd
+short_description: Run tasks in LXD instances using C(lxc) CLI
+description:
+  - Run commands or put/fetch files to an existing instance using C(lxc) CLI.
+options:
+  remote_addr:
     description:
-        - Run commands or put/fetch files to an existing instance using C(lxc) CLI.
-    options:
-      remote_addr:
-        description:
-            - Instance (container/VM) identifier.
-            - Since community.general 8.0.0, a FQDN can be provided; in that case, the first component (the part before C(.))
-              is used as the instance identifier.
-        type: string
-        default: inventory_hostname
-        vars:
-            - name: inventory_hostname
-            - name: ansible_host
-            - name: ansible_lxd_host
-      executable:
-        description:
-            - Shell to use for execution inside instance.
-        type: string
-        default: /bin/sh
-        vars:
-            - name: ansible_executable
-            - name: ansible_lxd_executable
-      remote:
-        description:
-            - Name of the LXD remote to use.
-        type: string
-        default: local
-        vars:
-            - name: ansible_lxd_remote
-        version_added: 2.0.0
-      project:
-        description:
-            - Name of the LXD project to use.
-        type: string
-        vars:
-            - name: ansible_lxd_project
-        version_added: 2.0.0
-'''
+      - Instance (container/VM) identifier.
+      - Since community.general 8.0.0, a FQDN can be provided; in that case, the first component (the part before C(.)) is
+        used as the instance identifier.
+    type: string
+    default: inventory_hostname
+    vars:
+      - name: inventory_hostname
+      - name: ansible_host
+      - name: ansible_lxd_host
+  executable:
+    description:
+      - Shell to use for execution inside instance.
+    type: string
+    default: /bin/sh
+    vars:
+      - name: ansible_executable
+      - name: ansible_lxd_executable
+  remote:
+    description:
+      - Name of the LXD remote to use.
+    type: string
+    default: local
+    vars:
+      - name: ansible_lxd_remote
+    version_added: 2.0.0
+  project:
+    description:
+      - Name of the LXD project to use.
+    type: string
+    vars:
+      - name: ansible_lxd_project
+    version_added: 2.0.0
+"""
 
 import os
 from subprocess import Popen, PIPE

plugins/connection/qubes.py

@@ -12,34 +12,33 @@ from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
 
-DOCUMENTATION = '''
-    name: qubes
-    short_description: Interact with an existing QubesOS AppVM
+DOCUMENTATION = r"""
+name: qubes
+short_description: Interact with an existing QubesOS AppVM
 
+description:
+  - Run commands or put/fetch files to an existing Qubes AppVM using qubes tools.
+author: Kushal Das (@kushaldas)
+
+
+options:
+  remote_addr:
     description:
-        - Run commands or put/fetch files to an existing Qubes AppVM using qubes tools.
-
-    author: Kushal Das (@kushaldas)
-
-
-    options:
-      remote_addr:
-        description:
-            - VM name.
-        type: string
-        default: inventory_hostname
-        vars:
-            - name: ansible_host
-      remote_user:
-        description:
-            - The user to execute as inside the VM.
-        type: string
-        default: The I(user) account as default in Qubes OS.
-        vars:
-            - name: ansible_user
+      - VM name.
+    type: string
+    default: inventory_hostname
+    vars:
+      - name: ansible_host
+  remote_user:
+    description:
+      - The user to execute as inside the VM.
+    type: string
+    default: The I(user) account as default in Qubes OS.
+    vars:
+      - name: ansible_user
 #        keyword:
 #            - name: hosts
-'''
+"""
 
 import subprocess
 
@@ -118,7 +117,7 @@ class Connection(ConnectionBase):
 
         rc, stdout, stderr = self._qubes(cmd)
 
-        display.vvvvv("STDOUT %r STDERR %r" % (stderr, stderr))
+        display.vvvvv("STDOUT %r STDERR %r" % (stdout, stderr))
         return rc, stdout, stderr
 
     def put_file(self, in_path, out_path):

plugins/connection/saltstack.py

@@ -10,13 +10,13 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = '''
-    author: Michael Scherer (@mscherer) <misc@zarb.org>
-    name: saltstack
-    short_description: Allow ansible to piggyback on salt minions
-    description:
-        - This allows you to use existing Saltstack infrastructure to connect to targets.
-'''
+DOCUMENTATION = r"""
+author: Michael Scherer (@mscherer) <misc@zarb.org>
+name: saltstack
+short_description: Allow ansible to piggyback on salt minions
+description:
+  - This allows you to use existing Saltstack infrastructure to connect to targets.
+"""
 
 import os
 import base64

plugins/connection/zone.py

@@ -11,22 +11,22 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = '''
-    author: Ansible Core Team
-    name: zone
-    short_description: Run tasks in a zone instance
+DOCUMENTATION = r"""
+author: Ansible Core Team
+name: zone
+short_description: Run tasks in a zone instance
+description:
+  - Run commands or put/fetch files to an existing zone.
+options:
+  remote_addr:
     description:
-        - Run commands or put/fetch files to an existing zone.
-    options:
-      remote_addr:
-        description:
-            - Zone identifier
-        type: string
-        default: inventory_hostname
-        vars:
-            - name: ansible_host
-            - name: ansible_zone_host
-'''
+      - Zone identifier.
+    type: string
+    default: inventory_hostname
+    vars:
+      - name: ansible_host
+      - name: ansible_zone_host
+"""
 
 import os
 import os.path

plugins/doc_fragments/onepassword.py

@@ -9,7 +9,7 @@ __metaclass__ = type
 
 
 class ModuleDocFragment(object):
-    DOCUMENTATION = r'''
+    DOCUMENTATION = r"""
 requirements:
   - See U(https://support.1password.com/command-line/)
 options:
@@ -18,7 +18,8 @@ options:
     aliases: ['vault_password']
     type: str
   section:
-    description: Item section containing the field to retrieve (case-insensitive). If absent will return first match from any section.
+    description: Item section containing the field to retrieve (case-insensitive). If absent will return first match from
+      any section.
   domain:
     description: Domain of 1Password.
     default: '1password.com'
@@ -55,25 +56,25 @@ options:
     env:
       - name: OP_CONNECT_TOKEN
     version_added: 8.1.0
-'''
+"""
 
-    LOOKUP = r'''
+    LOOKUP = r"""
 options:
   service_account_token:
     env:
       - name: OP_SERVICE_ACCOUNT_TOKEN
         version_added: 8.2.0
 notes:
-  - This lookup will use an existing 1Password session if one exists. If not, and you have already
-    performed an initial sign in (meaning C(~/.op/config), C(~/.config/op/config) or C(~/.config/.op/config) exists), then only the
-    O(master_password) is required. You may optionally specify O(subdomain) in this scenario, otherwise the last used subdomain will be used by C(op).
+  - This lookup will use an existing 1Password session if one exists. If not, and you have already performed an initial sign
+    in (meaning C(~/.op/config), C(~/.config/op/config) or C(~/.config/.op/config) exists), then only the O(master_password)
+    is required. You may optionally specify O(subdomain) in this scenario, otherwise the last used subdomain will be used
+    by C(op).
   - This lookup can perform an initial login by providing O(subdomain), O(username), O(secret_key), and O(master_password).
   - Can target a specific account by providing the O(account_id).
-  - Due to the B(very) sensitive nature of these credentials, it is B(highly) recommended that you only pass in the minimal credentials
-    needed at any given time. Also, store these credentials in an Ansible Vault using a key that is equal to or greater in strength
-    to the 1Password master password.
-  - This lookup stores potentially sensitive data from 1Password as Ansible facts.
-    Facts are subject to caching if enabled, which means this data could be stored in clear text
-    on disk or in a database.
+  - Due to the B(very) sensitive nature of these credentials, it is B(highly) recommended that you only pass in the minimal
+    credentials needed at any given time. Also, store these credentials in an Ansible Vault using a key that is equal to or
+    greater in strength to the 1Password master password.
+  - This lookup stores potentially sensitive data from 1Password as Ansible facts. Facts are subject to caching if enabled,
+    which means this data could be stored in clear text on disk or in a database.
   - Tested with C(op) version 2.7.2.
-'''
+"""

plugins/doc_fragments/oneview.py

@@ -11,70 +11,67 @@ __metaclass__ = type
 class ModuleDocFragment(object):
 
     # OneView doc fragment
-    DOCUMENTATION = r'''
+    DOCUMENTATION = r"""
 options:
-    config:
-        description:
-        - Path to a JSON configuration file containing the OneView client configuration.
-          The configuration file is optional and when used should be present in the host running the ansible commands.
-          If the file path is not provided, the configuration will be loaded from environment variables.
-          For links to example configuration files or how to use the environment variables verify the notes section.
-        type: path
-    api_version:
-        description:
-        - OneView API Version.
-        type: int
-    image_streamer_hostname:
-        description:
-        - IP address or hostname for the HPE Image Streamer REST API.
-        type: str
-    hostname:
-        description:
-        - IP address or hostname for the appliance.
-        type: str
-    username:
-        description:
-        - Username for API authentication.
-        type: str
-    password:
-        description:
-        - Password for API authentication.
-        type: str
+  config:
+    description:
+      - Path to a JSON configuration file containing the OneView client configuration. The configuration file is optional
+        and when used should be present in the host running the ansible commands. If the file path is not provided, the configuration
+        will be loaded from environment variables. For links to example configuration files or how to use the environment
+        variables verify the notes section.
+    type: path
+  api_version:
+    description:
+      - OneView API Version.
+    type: int
+  image_streamer_hostname:
+    description:
+      - IP address or hostname for the HPE Image Streamer REST API.
+    type: str
+  hostname:
+    description:
+      - IP address or hostname for the appliance.
+    type: str
+  username:
+    description:
+      - Username for API authentication.
+    type: str
+  password:
+    description:
+      - Password for API authentication.
+    type: str
 
 requirements:
   - Python >= 2.7.9
 
 notes:
-    - "A sample configuration file for the config parameter can be found at:
-       U(https://github.com/HewlettPackard/oneview-ansible/blob/master/examples/oneview_config-rename.json)"
-    - "Check how to use environment variables for configuration at:
-       U(https://github.com/HewlettPackard/oneview-ansible#environment-variables)"
-    - "Additional Playbooks for the HPE OneView Ansible modules can be found at:
-       U(https://github.com/HewlettPackard/oneview-ansible/tree/master/examples)"
-    - "The OneView API version used will directly affect returned and expected fields in resources.
-       Information on setting the desired API version and can be found at:
-       U(https://github.com/HewlettPackard/oneview-ansible#setting-your-oneview-version)"
-    '''
+  - 'A sample configuration file for the config parameter can be found at:
+    U(https://github.com/HewlettPackard/oneview-ansible/blob/master/examples/oneview_config-rename.json).'
+  - 'Check how to use environment variables for configuration at: U(https://github.com/HewlettPackard/oneview-ansible#environment-variables).'
+  - 'Additional Playbooks for the HPE OneView Ansible modules can be found at: U(https://github.com/HewlettPackard/oneview-ansible/tree/master/examples).'
+  - 'The OneView API version used will directly affect returned and expected fields in resources. Information on setting the
+    desired API version and can be found at: U(https://github.com/HewlettPackard/oneview-ansible#setting-your-oneview-version).'
+"""
 
-    VALIDATEETAG = r'''
+    VALIDATEETAG = r"""
 options:
-    validate_etag:
-        description:
-            - When the ETag Validation is enabled, the request will be conditionally processed only if the current ETag
-                for the resource matches the ETag provided in the data.
-        type: bool
-        default: true
-'''
+  validate_etag:
+    description:
+      - When the ETag Validation is enabled, the request will be conditionally processed only if the current ETag for the
+        resource matches the ETag provided in the data.
+    type: bool
+    default: true
+"""
 
-    FACTSPARAMS = r'''
+    FACTSPARAMS = r"""
 options:
-    params:
-        description:
-        - List of parameters to delimit, filter and sort the list of resources.
-        - "Parameter keys allowed are:"
-        - "C(start): The first item to return, using 0-based indexing."
-        - "C(count): The number of resources to return."
-        - "C(filter): A general filter/query string to narrow the list of items returned."
-        - "C(sort): The sort order of the returned data set."
-        type: dict
-'''
+  params:
+    description:
+      - List of parameters to delimit, filter and sort the list of resources.
+      - 'Parameter keys allowed are:'
+      - 'V(start): The first item to return, using 0-based indexing.'
+      - 'V(count): The number of resources to return.'
+      - 'V(filter): A general filter/query string to narrow the list of items returned.'
+      - 'V(sort): The sort order of the returned data set.'
+    type: dict
+"""

plugins/doc_fragments/online.py

@@ -10,26 +10,26 @@ __metaclass__ = type
 class ModuleDocFragment(object):
 
     # Standard documentation fragment
-    DOCUMENTATION = r'''
+    DOCUMENTATION = r"""
 options:
   api_token:
     description:
       - Online OAuth token.
     type: str
     required: true
-    aliases: [ oauth_token ]
+    aliases: [oauth_token]
   api_url:
     description:
       - Online API URL.
     type: str
     default: 'https://api.online.net'
-    aliases: [ base_url ]
+    aliases: [base_url]
   api_timeout:
     description:
       - HTTP timeout to Online API in seconds.
     type: int
     default: 30
-    aliases: [ timeout ]
+    aliases: [timeout]
   validate_certs:
     description:
       - Validate SSL certs of the Online API.
@@ -37,9 +37,7 @@ options:
     default: true
 notes:
   - Also see the API documentation on U(https://console.online.net/en/api/).
-  - If O(api_token) is not set within the module, the following
-    environment variables can be used in decreasing order of precedence
+  - If O(api_token) is not set within the module, the following environment variables can be used in decreasing order of precedence
     E(ONLINE_TOKEN), E(ONLINE_API_KEY), E(ONLINE_OAUTH_TOKEN), E(ONLINE_API_TOKEN).
-  - If one wants to use a different O(api_url) one can also set the E(ONLINE_API_URL)
-    environment variable.
-'''
+  - If one wants to use a different O(api_url) one can also set the E(ONLINE_API_URL) environment variable.
+"""

plugins/doc_fragments/opennebula.py

@@ -10,36 +10,36 @@ __metaclass__ = type
 
 class ModuleDocFragment(object):
     # OpenNebula common documentation
-    DOCUMENTATION = r'''
+    DOCUMENTATION = r"""
 options:
-    api_url:
-        description:
-            - The ENDPOINT URL of the XMLRPC server.
-            - If not specified then the value of the E(ONE_URL) environment variable, if any, is used.
-        type: str
-        aliases:
-            - api_endpoint
-    api_username:
-        description:
-            - The name of the user for XMLRPC authentication.
-            - If not specified then the value of the E(ONE_USERNAME) environment variable, if any, is used.
-        type: str
-    api_password:
-        description:
-            - The password or token for XMLRPC authentication.
-            - If not specified then the value of the E(ONE_PASSWORD) environment variable, if any, is used.
-        type: str
-        aliases:
-            - api_token
-    validate_certs:
-        description:
-            - Whether to validate the TLS/SSL certificates or not.
-            - This parameter is ignored if E(PYTHONHTTPSVERIFY) environment variable is used.
-        type: bool
-        default: true
-    wait_timeout:
-        description:
-            - Time to wait for the desired state to be reached before timeout, in seconds.
-        type: int
-        default: 300
-'''
+  api_url:
+    description:
+      - The ENDPOINT URL of the XMLRPC server.
+      - If not specified then the value of the E(ONE_URL) environment variable, if any, is used.
+    type: str
+    aliases:
+      - api_endpoint
+  api_username:
+    description:
+      - The name of the user for XMLRPC authentication.
+      - If not specified then the value of the E(ONE_USERNAME) environment variable, if any, is used.
+    type: str
+  api_password:
+    description:
+      - The password or token for XMLRPC authentication.
+      - If not specified then the value of the E(ONE_PASSWORD) environment variable, if any, is used.
+    type: str
+    aliases:
+      - api_token
+  validate_certs:
+    description:
+      - Whether to validate the TLS/SSL certificates or not.
+      - This parameter is ignored if E(PYTHONHTTPSVERIFY) environment variable is used.
+    type: bool
+    default: true
+  wait_timeout:
+    description:
+      - Time to wait for the desired state to be reached before timeout, in seconds.
+    type: int
+    default: 300
+"""

plugins/doc_fragments/openswitch.py

@@ -11,75 +11,62 @@ __metaclass__ = type
 class ModuleDocFragment(object):
 
     # Standard files documentation fragment
-    DOCUMENTATION = r'''
+    DOCUMENTATION = r"""
 options:
   host:
     description:
-      - Specifies the DNS host name or address for connecting to the remote
-        device over the specified transport.  The value of host is used as
-        the destination address for the transport.  Note this argument
-        does not affect the SSH argument.
+      - Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value
+        of host is used as the destination address for the transport. Note this argument does not affect the SSH argument.
     type: str
   port:
     description:
-      - Specifies the port to use when building the connection to the remote
-        device.  This value applies to either O(transport=cli) or O(transport=rest).  The port
-        value will default to the appropriate transport common port if
-        none is provided in the task.  (cli=22, http=80, https=443).  Note
-        this argument does not affect the SSH transport.
+      - Specifies the port to use when building the connection to the remote device. This value applies to either O(transport=cli)
+        or O(transport=rest). The port value will default to the appropriate transport common port if none is provided in
+        the task. (cli=22, http=80, https=443). Note this argument does not affect the SSH transport.
     type: int
     default: 0 (use common port)
   username:
     description:
-      - Configures the username to use to authenticate the connection to
-        the remote device.  This value is used to authenticate
-        either the CLI login or the eAPI authentication depending on which
-        transport is used. Note this argument does not affect the SSH
-        transport. If the value is not specified in the task, the value of
-        environment variable E(ANSIBLE_NET_USERNAME) will be used instead.
+      - Configures the username to use to authenticate the connection to the remote device. This value is used to authenticate
+        either the CLI login or the eAPI authentication depending on which transport is used. Note this argument does not
+        affect the SSH transport. If the value is not specified in the task, the value of environment variable E(ANSIBLE_NET_USERNAME)
+        will be used instead.
     type: str
   password:
     description:
-      - Specifies the password to use to authenticate the connection to
-        the remote device.  This is a common argument used for either O(transport=cli)
-        or O(transport=rest).  Note this argument does not affect the SSH
-        transport. If the value is not specified in the task, the value of
-        environment variable E(ANSIBLE_NET_PASSWORD) will be used instead.
+      - Specifies the password to use to authenticate the connection to the remote device. This is a common argument used
+        for either O(transport=cli) or O(transport=rest). Note this argument does not affect the SSH transport. If the value
+        is not specified in the task, the value of environment variable E(ANSIBLE_NET_PASSWORD) will be used instead.
     type: str
   timeout:
     description:
-      - Specifies the timeout in seconds for communicating with the network device
-        for either connecting or sending commands.  If the timeout is
-        exceeded before the operation is completed, the module will error.
+      - Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands.
+        If the timeout is exceeded before the operation is completed, the module will error.
     type: int
     default: 10
   ssh_keyfile:
     description:
-      - Specifies the SSH key to use to authenticate the connection to
-        the remote device.  This argument is only used for O(transport=cli).
-        If the value is not specified in the task, the value of
-        environment variable E(ANSIBLE_NET_SSH_KEYFILE) will be used instead.
+      - Specifies the SSH key to use to authenticate the connection to the remote device. This argument is only used for O(transport=cli).
+        If the value is not specified in the task, the value of environment variable E(ANSIBLE_NET_SSH_KEYFILE) will be used
+        instead.
     type: path
   transport:
     description:
-      - Configures the transport connection to use when connecting to the
-        remote device.  The transport argument supports connectivity to the
-        device over SSH (V(ssh)), CLI (V(cli)), or REST (V(rest)).
+      - Configures the transport connection to use when connecting to the remote device. The transport argument supports connectivity
+        to the device over SSH (V(ssh)), CLI (V(cli)), or REST (V(rest)).
     required: true
     type: str
-    choices: [ cli, rest, ssh ]
+    choices: [cli, rest, ssh]
     default: ssh
   use_ssl:
     description:
-      - Configures the O(transport) to use SSL if set to V(true) only when the
-        O(transport) argument is configured as rest.  If the transport
-        argument is not V(rest), this value is ignored.
+      - Configures the O(transport) to use SSL if set to V(true) only when the O(transport) argument is configured as rest.
+        If the transport argument is not V(rest), this value is ignored.
     type: bool
     default: true
   provider:
     description:
-      - Convenience method that allows all C(openswitch) arguments to be passed as
-        a dict object.  All constraints (required, choices, etc) must be
-        met either by individual arguments or values in this dict.
+      - Convenience method that allows all C(openswitch) arguments to be passed as a dict object. All constraints (required,
+        choices, and so on) must be met either by individual arguments or values in this dict.
     type: dict
-'''
+"""

plugins/doc_fragments/oracle.py

@@ -8,76 +8,68 @@ __metaclass__ = type
 
 
 class ModuleDocFragment(object):
-    DOCUMENTATION = """
-    requirements:
-        - Python SDK for Oracle Cloud Infrastructure U(https://oracle-cloud-infrastructure-python-sdk.readthedocs.io)
-    notes:
-        - For OCI Python SDK configuration, please refer to
-          U(https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html).
-    options:
-        config_file_location:
-            description:
-                - Path to configuration file. If not set then the value of the E(OCI_CONFIG_FILE) environment variable,
-                  if any, is used. Otherwise, defaults to C(~/.oci/config).
-            type: str
-        config_profile_name:
-            description:
-                - The profile to load from the config file referenced by O(config_file_location). If not set, then the
-                  value of the E(OCI_CONFIG_PROFILE) environment variable, if any, is used. Otherwise, defaults to the
-                  C(DEFAULT) profile in O(config_file_location).
-            default: "DEFAULT"
-            type: str
-        api_user:
-            description:
-                - The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the
-                  value of the E(OCI_USER_OCID) environment variable, if any, is used. This option is required if the user
-                  is not specified through a configuration file (See O(config_file_location)). To get the user's OCID,
-                  please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm).
-            type: str
-        api_user_fingerprint:
-            description:
-                - Fingerprint for the key pair being used. If not set, then the value of the E(OCI_USER_FINGERPRINT)
-                  environment variable, if any, is used. This option is required if the key fingerprint is not
-                  specified through a configuration file (See O(config_file_location)). To get the key pair's
-                  fingerprint value please refer
-                  U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm).
-            type: str
-        api_user_key_file:
-            description:
-                - Full path and filename of the private key (in PEM format). If not set, then the value of the
-                  OCI_USER_KEY_FILE variable, if any, is used. This option is required if the private key is
-                  not specified through a configuration file (See O(config_file_location)). If the key is encrypted
-                  with a pass-phrase, the O(api_user_key_pass_phrase) option must also be provided.
-            type: path
-        api_user_key_pass_phrase:
-            description:
-                - Passphrase used by the key referenced in O(api_user_key_file), if it is encrypted. If not set, then
-                  the value of the OCI_USER_KEY_PASS_PHRASE variable, if any, is used. This option is required if the
-                  key passphrase is not specified through a configuration file (See O(config_file_location)).
-            type: str
-        auth_type:
-            description:
-                - The type of authentication to use for making API requests. By default O(auth_type=api_key) based
-                  authentication is performed and the API key (see O(api_user_key_file)) in your config file will be
-                  used. If this 'auth_type' module option is not specified, the value of the OCI_ANSIBLE_AUTH_TYPE,
-                  if any, is used. Use O(auth_type=instance_principal) to use instance principal based authentication
-                  when running ansible playbooks within an OCI compute instance.
-            choices: ['api_key', 'instance_principal']
-            default: 'api_key'
-            type: str
-        tenancy:
-            description:
-                - OCID of your tenancy. If not set, then the value of the OCI_TENANCY variable, if any, is
-                  used. This option is required if the tenancy OCID is not specified through a configuration file
-                  (See O(config_file_location)). To get the tenancy OCID, please refer to
-                  U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm).
-            type: str
-        region:
-            description:
-                - The Oracle Cloud Infrastructure region to use for all OCI API requests. If not set, then the
-                  value of the OCI_REGION variable, if any, is used. This option is required if the region is
-                  not specified through a configuration file (See O(config_file_location)). Please refer to
-                  U(https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm) for more information
-                  on OCI regions.
-            type: str
-    """
+    DOCUMENTATION = r"""
+requirements:
+  - Python SDK for Oracle Cloud Infrastructure U(https://oracle-cloud-infrastructure-python-sdk.readthedocs.io)
+notes:
+  - For OCI Python SDK configuration, please refer to U(https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html).
+options:
+  config_file_location:
+    description:
+      - Path to configuration file. If not set then the value of the E(OCI_CONFIG_FILE) environment variable, if any, is used.
+        Otherwise, defaults to C(~/.oci/config).
+    type: str
+  config_profile_name:
+    description:
+      - The profile to load from the config file referenced by O(config_file_location). If not set, then the value of the
+        E(OCI_CONFIG_PROFILE) environment variable, if any, is used. Otherwise, defaults to the C(DEFAULT) profile in O(config_file_location).
+    default: "DEFAULT"
+    type: str
+  api_user:
+    description:
+      - The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the value of the E(OCI_USER_OCID) environment
+        variable, if any, is used. This option is required if the user is not specified through a configuration file (See
+        O(config_file_location)). To get the user's OCID, please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm).
+    type: str
+  api_user_fingerprint:
+    description:
+      - Fingerprint for the key pair being used. If not set, then the value of the E(OCI_USER_FINGERPRINT) environment variable,
+        if any, is used. This option is required if the key fingerprint is not specified through a configuration file (See
+        O(config_file_location)). To get the key pair's fingerprint value please refer to
+        U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm).
+    type: str
+  api_user_key_file:
+    description:
+      - Full path and filename of the private key (in PEM format). If not set, then the value of the E(OCI_USER_KEY_FILE) variable,
+        if any, is used. This option is required if the private key is not specified through a configuration file (See O(config_file_location)).
+        If the key is encrypted with a pass-phrase, the O(api_user_key_pass_phrase) option must also be provided.
+    type: path
+  api_user_key_pass_phrase:
+    description:
+      - Passphrase used by the key referenced in O(api_user_key_file), if it is encrypted. If not set, then the value of the
+        E(OCI_USER_KEY_PASS_PHRASE) variable, if any, is used. This option is required if the key passphrase is not specified
+        through a configuration file (See O(config_file_location)).
+    type: str
+  auth_type:
+    description:
+      - The type of authentication to use for making API requests. By default O(auth_type=api_key) based authentication is
+        performed and the API key (see O(api_user_key_file)) in your config file will be used. If this 'auth_type' module
+        option is not specified, the value of the E(OCI_ANSIBLE_AUTH_TYPE), if any, is used. Use O(auth_type=instance_principal)
+        to use instance principal based authentication when running ansible playbooks within an OCI compute instance.
+    choices: ['api_key', 'instance_principal']
+    default: 'api_key'
+    type: str
+  tenancy:
+    description:
+      - OCID of your tenancy. If not set, then the value of the E(OCI_TENANCY) variable, if any, is used. This option is required
+        if the tenancy OCID is not specified through a configuration file (See O(config_file_location)). To get the tenancy
+        OCID, please refer to U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm).
+    type: str
+  region:
+    description:
+      - The Oracle Cloud Infrastructure region to use for all OCI API requests. If not set, then the value of the E(OCI_REGION)
+        variable, if any, is used. This option is required if the region is not specified through a configuration file (See
+        O(config_file_location)). Please refer to U(https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm)
+        for more information on OCI regions.
+    type: str
+"""

plugins/doc_fragments/oracle_creatable_resource.py

@@ -8,19 +8,18 @@ __metaclass__ = type
 
 
 class ModuleDocFragment(object):
-    DOCUMENTATION = """
-    options:
-        force_create:
-            description: Whether to attempt non-idempotent creation of a resource. By default, create resource is an
-                         idempotent operation, and doesn't create the resource if it already exists. Setting this option
-                         to true, forcefully creates a copy of the resource, even if it already exists.This option is
-                         mutually exclusive with O(key_by).
-            default: false
-            type: bool
-        key_by:
-            description: The list of comma-separated attributes of this resource which should be used to uniquely
-                         identify an instance of the resource. By default, all the attributes of a resource except
-                         O(freeform_tags) are used to uniquely identify a resource.
-            type: list
-            elements: str
-    """
+    DOCUMENTATION = r"""
+options:
+  force_create:
+    description: Whether to attempt non-idempotent creation of a resource. By default, create resource is an idempotent operation,
+      and does not create the resource if it already exists. Setting this option to V(true), forcefully creates a copy of the
+      resource, even if it already exists. This option is mutually exclusive with O(key_by).
+    default: false
+    type: bool
+  key_by:
+    description: The list of comma-separated attributes of this resource which should be used to uniquely identify an instance
+      of the resource. By default, all the attributes of a resource except O(freeform_tags) are used to uniquely identify
+      a resource.
+    type: list
+    elements: str
+"""

plugins/doc_fragments/oracle_display_name_option.py

@@ -8,10 +8,10 @@ __metaclass__ = type
 
 
 class ModuleDocFragment(object):
-    DOCUMENTATION = """
-    options:
-        display_name:
-            description: Use O(display_name) along with the other options to return only resources that match the given
-                         display name exactly.
-            type: str
-    """
+    DOCUMENTATION = r"""
+options:
+  display_name:
+    description: Use O(display_name) along with the other options to return only resources that match the given display name
+      exactly.
+    type: str
+"""

plugins/doc_fragments/oracle_name_option.py

@@ -8,10 +8,9 @@ __metaclass__ = type
 
 
 class ModuleDocFragment(object):
-    DOCUMENTATION = """
-    options:
-        name:
-            description: Use O(name) along with the other options to return only resources that match the given name
-                         exactly.
-            type: str
-    """
+    DOCUMENTATION = r"""
+options:
+  name:
+    description: Use O(name) along with the other options to return only resources that match the given name exactly.
+    type: str
+"""

plugins/doc_fragments/oracle_tags.py

@@ -8,16 +8,14 @@ __metaclass__ = type
 
 
 class ModuleDocFragment(object):
-    DOCUMENTATION = """
-    options:
-        defined_tags:
-            description: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more
-                         information, see
-                         U(https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
-            type: dict
-        freeform_tags:
-            description: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name,
-                         type, or namespace. For more information, see
-                         U(https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
-            type: dict
-    """
+    DOCUMENTATION = r"""
+options:
+  defined_tags:
+    description: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see
+      U(https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
+    type: dict
+  freeform_tags:
+    description: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
+      For more information, see U(https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
+    type: dict
+"""

plugins/doc_fragments/oracle_wait_options.py

@@ -8,20 +8,19 @@ __metaclass__ = type
 
 
 class ModuleDocFragment(object):
-    DOCUMENTATION = """
-    options:
-        wait:
-            description: Whether to wait for create or delete operation to complete.
-            default: true
-            type: bool
-        wait_timeout:
-            description: Time, in seconds, to wait when O(wait=true).
-            default: 1200
-            type: int
-        wait_until:
-            description: The lifecycle state to wait for the resource to transition into when O(wait=true). By default,
-                         when O(wait=true), we wait for the resource to get into ACTIVE/ATTACHED/AVAILABLE/PROVISIONED/
-                         RUNNING applicable lifecycle state during create operation and to get into DELETED/DETACHED/
-                         TERMINATED lifecycle state during delete operation.
-            type: str
-    """
+    DOCUMENTATION = r"""
+options:
+  wait:
+    description: Whether to wait for create or delete operation to complete.
+    default: true
+    type: bool
+  wait_timeout:
+    description: Time, in seconds, to wait when O(wait=true).
+    default: 1200
+    type: int
+  wait_until:
+    description: The lifecycle state to wait for the resource to transition into when O(wait=true). By default, when O(wait=true),
+      we wait for the resource to get into ACTIVE/ATTACHED/AVAILABLE/PROVISIONED/ RUNNING applicable lifecycle state during
+      create operation and to get into DELETED/DETACHED/ TERMINATED lifecycle state during delete operation.
+    type: str
+"""

plugins/doc_fragments/pipx.py

@@ -9,34 +9,32 @@ __metaclass__ = type
 
 
 class ModuleDocFragment(object):
-    DOCUMENTATION = r'''
+    DOCUMENTATION = r"""
 options:
   global:
     description:
       - The module will pass the C(--global) argument to C(pipx), to execute actions in global scope.
       - The C(--global) is only available in C(pipx>=1.6.0), so make sure to have a compatible version when using this option.
-          Moreover, a nasty bug with C(--global) was fixed in C(pipx==1.7.0), so it is strongly recommended you used that version or newer.
+        Moreover, a nasty bug with C(--global) was fixed in C(pipx==1.7.0), so it is strongly recommended you used that version
+        or newer.
     type: bool
     default: false
   executable:
     description:
       - Path to the C(pipx) installed in the system.
-      - >
-        If not specified, the module will use C(python -m pipx) to run the tool,
-        using the same Python interpreter as ansible itself.
+      - If not specified, the module will use C(python -m pipx) to run the tool, using the same Python interpreter as ansible
+        itself.
     type: path
 notes:
-    - This module requires C(pipx) version 0.16.2.1 or above. From community.general 11.0.0 onwards, the module will require C(pipx>=1.7.0).
-    - Please note that C(pipx) requires Python 3.6 or above.
-    - This module does not install the C(pipx) python package, however that can be easily done with the module M(ansible.builtin.pip).
-    - This module does not require C(pipx) to be in the shell C(PATH), but it must be loadable by Python as a module.
-    - >
-      This module will honor C(pipx) environment variables such as but not limited to E(PIPX_HOME) and E(PIPX_BIN_DIR)
-      passed using the R(environment Ansible keyword, playbooks_environment).
-
+  - This module requires C(pipx) version 0.16.2.1 or above. From community.general 11.0.0 onwards, the module will require
+    C(pipx>=1.7.0).
+  - Please note that C(pipx) requires Python 3.6 or above.
+  - This module does not install the C(pipx) python package, however that can be easily done with the module M(ansible.builtin.pip).
+  - This module does not require C(pipx) to be in the shell C(PATH), but it must be loadable by Python as a module.
+  - This module will honor C(pipx) environment variables such as but not limited to E(PIPX_HOME) and E(PIPX_BIN_DIR) passed
+    using the R(environment Ansible keyword, playbooks_environment).
 seealso:
   - name: C(pipx) command manual page
     description: Manual page for the command.
     link: https://pipx.pypa.io/latest/docs/
-
-'''
+"""

plugins/doc_fragments/pritunl.py

@@ -13,32 +13,28 @@ class ModuleDocFragment(object):
 
     DOCUMENTATION = r"""
 options:
-    pritunl_url:
-        type: str
-        required: true
-        description:
-        - URL and port of the Pritunl server on which the API is enabled.
-
-    pritunl_api_token:
-        type: str
-        required: true
-        description:
-        - API Token of a Pritunl admin user.
-        - It needs to be enabled in Administrators > USERNAME > Enable Token Authentication.
-
-    pritunl_api_secret:
-        type: str
-        required: true
-        description:
-        - API Secret found in Administrators > USERNAME > API Secret.
-
-    validate_certs:
-        type: bool
-        required: false
-        default: true
-        description:
-        - If certificates should be validated or not.
-        - This should never be set to V(false), except if you are very sure that
-          your connection to the server can not be subject to a Man In The Middle
-          attack.
+  pritunl_url:
+    type: str
+    required: true
+    description:
+      - URL and port of the Pritunl server on which the API is enabled.
+  pritunl_api_token:
+    type: str
+    required: true
+    description:
+      - API Token of a Pritunl admin user.
+      - It needs to be enabled in Administrators > USERNAME > Enable Token Authentication.
+  pritunl_api_secret:
+    type: str
+    required: true
+    description:
+      - API Secret found in Administrators > USERNAME > API Secret.
+  validate_certs:
+    type: bool
+    required: false
+    default: true
+    description:
+      - If certificates should be validated or not.
+      - This should never be set to V(false), except if you are very sure that your connection to the server can not be subject
+        to a Man In The Middle attack.
 """

plugins/doc_fragments/proxmox.py

@@ -9,7 +9,7 @@ __metaclass__ = type
 
 class ModuleDocFragment(object):
     # Common parameters for Proxmox VE modules
-    DOCUMENTATION = r'''
+    DOCUMENTATION = r"""
 options:
   api_host:
     description:
@@ -51,10 +51,10 @@ options:
       - This should only be used on personally controlled sites using self-signed certificates.
     type: bool
     default: false
-requirements: [ "proxmoxer", "requests" ]
-'''
+requirements: ["proxmoxer", "requests"]
+"""
 
-    SELECTION = r'''
+    SELECTION = r"""
 options:
   vmid:
     description:
@@ -71,7 +71,7 @@ options:
     description:
       - Add the new VM to the specified pool.
     type: str
-'''
+"""
 
     ACTIONGROUP_PROXMOX = r"""
 options: {}

plugins/doc_fragments/purestorage.py

@@ -11,17 +11,17 @@ __metaclass__ = type
 class ModuleDocFragment(object):
 
     # Standard Pure Storage documentation fragment
-    DOCUMENTATION = r'''
-options:
-  - See separate platform section for more details
+    DOCUMENTATION = r"""
+options: {}
+# See separate platform section for more details
 requirements:
   - See separate platform section for more details
 notes:
-  - Ansible modules are available for the following Pure Storage products: FlashArray, FlashBlade
-'''
+  - 'Ansible modules are available for the following Pure Storage products: FlashArray, FlashBlade.'
+"""
 
     # Documentation fragment for FlashBlade
-    FB = r'''
+    FB = r"""
 options:
   fb_url:
     description:
@@ -33,14 +33,14 @@ options:
     type: str
 notes:
   - This module requires the C(purity_fb) Python library.
-  - You must set E(PUREFB_URL) and E(PUREFB_API) environment variables
-    if O(fb_url) and O(api_token) arguments are not passed to the module directly.
+  - You must set E(PUREFB_URL) and E(PUREFB_API) environment variables if O(fb_url) and O(api_token) arguments are not passed
+    to the module directly.
 requirements:
   - purity_fb >= 1.1
-'''
+"""
 
     # Documentation fragment for FlashArray
-    FA = r'''
+    FA = r"""
 options:
   fa_url:
     description:
@@ -54,8 +54,8 @@ options:
     required: true
 notes:
   - This module requires the C(purestorage) Python library.
-  - You must set E(PUREFA_URL) and E(PUREFA_API) environment variables
-    if O(fa_url) and O(api_token) arguments are not passed to the module directly.
+  - You must set E(PUREFA_URL) and E(PUREFA_API) environment variables if O(fa_url) and O(api_token) arguments are not passed
+    to the module directly.
 requirements:
   - purestorage
-'''
+"""

plugins/doc_fragments/redis.py

@@ -10,7 +10,7 @@ __metaclass__ = type
 
 class ModuleDocFragment(object):
     # Common parameters for Redis modules
-    DOCUMENTATION = r'''
+    DOCUMENTATION = r"""
 options:
   login_host:
     description:
@@ -40,14 +40,12 @@ options:
   validate_certs:
     description:
       - Specify whether or not to validate TLS certificates.
-      - This should only be turned off for personally controlled sites or with
-        C(localhost) as target.
+      - This should only be turned off for personally controlled sites or with C(localhost) as target.
     type: bool
     default: true
   ca_certs:
     description:
-      - Path to root certificates file. If not set and O(tls) is
-        set to V(true), certifi ca-certificates will be used.
+      - Path to root certificates file. If not set and O(tls) is set to V(true), certifi ca-certificates will be used.
     type: str
   client_cert_file:
     description:
@@ -59,10 +57,9 @@ options:
       - Path to the client private key file.
     type: str
     version_added: 9.3.0
-requirements: [ "redis", "certifi" ]
+requirements: ["redis", "certifi"]
 
 notes:
-  - Requires the C(redis) Python package on the remote host. You can
-    install it with pip (C(pip install redis)) or with a package manager.
-    Information on the library can be found at U(https://github.com/andymccurdy/redis-py).
-'''
+  - Requires the C(redis) Python package on the remote host. You can install it with pip (C(pip install redis)) or with a
+    package manager. Information on the library can be found at U(https://github.com/andymccurdy/redis-py).
+"""

plugins/doc_fragments/rundeck.py

@@ -11,7 +11,7 @@ __metaclass__ = type
 class ModuleDocFragment(object):
 
     # Standard files documentation fragment
-    DOCUMENTATION = r'''
+    DOCUMENTATION = r"""
 options:
   url:
     type: str
@@ -29,4 +29,4 @@ options:
     description:
       - Rundeck User API Token.
     required: true
-'''
+"""

plugins/doc_fragments/scaleway.py

@@ -11,29 +11,29 @@ __metaclass__ = type
 class ModuleDocFragment(object):
 
     # Standard documentation fragment
-    DOCUMENTATION = r'''
+    DOCUMENTATION = r"""
 options:
   api_token:
     description:
       - Scaleway OAuth token.
     type: str
     required: true
-    aliases: [ oauth_token ]
+    aliases: [oauth_token]
   api_url:
     description:
       - Scaleway API URL.
     type: str
     default: https://api.scaleway.com
-    aliases: [ base_url ]
+    aliases: [base_url]
   api_timeout:
     description:
       - HTTP timeout to Scaleway API in seconds.
     type: int
     default: 30
-    aliases: [ timeout ]
+    aliases: [timeout]
   query_parameters:
     description:
-    - List of parameters passed to the query string.
+      - List of parameters passed to the query string.
     type: dict
     default: {}
   validate_certs:
@@ -43,9 +43,7 @@ options:
     default: true
 notes:
   - Also see the API documentation on U(https://developer.scaleway.com/).
-  - If O(api_token) is not set within the module, the following
-    environment variables can be used in decreasing order of precedence
+  - If O(api_token) is not set within the module, the following environment variables can be used in decreasing order of precedence
     E(SCW_TOKEN), E(SCW_API_KEY), E(SCW_OAUTH_TOKEN) or E(SCW_API_TOKEN).
-  - If one wants to use a different O(api_url) one can also set the E(SCW_API_URL)
-    environment variable.
-'''
+  - If one wants to use a different O(api_url) one can also set the E(SCW_API_URL) environment variable.
+"""

plugins/doc_fragments/scaleway_waitable_resource.py

@@ -11,23 +11,23 @@ __metaclass__ = type
 class ModuleDocFragment(object):
 
     # Standard documentation fragment
-    DOCUMENTATION = r'''
+    DOCUMENTATION = r"""
 options:
   wait:
     description:
-    - Wait for the resource to reach its desired state before returning.
+      - Wait for the resource to reach its desired state before returning.
     type: bool
     default: true
   wait_timeout:
     type: int
     description:
-    - Time to wait for the resource to reach the expected state.
+      - Time to wait for the resource to reach the expected state.
     required: false
     default: 300
   wait_sleep_time:
     type: int
     description:
-    - Time to wait before every attempt to check the state of the resource.
+      - Time to wait before every attempt to check the state of the resource.
     required: false
     default: 3
-'''
+"""

plugins/doc_fragments/utm.py

@@ -9,49 +9,48 @@ __metaclass__ = type
 
 
 class ModuleDocFragment(object):
-    DOCUMENTATION = r'''
+    DOCUMENTATION = r"""
 options:
-    headers:
-        description:
-          - A dictionary of additional headers to be sent to POST and PUT requests.
-          - Is needed for some modules.
-        type: dict
-        required: false
-        default: {}
-    utm_host:
-        description:
-          - The REST Endpoint of the Sophos UTM.
-        type: str
-        required: true
-    utm_port:
-        description:
-          - The port of the REST interface.
-        type: int
-        default: 4444
-    utm_token:
-        description:
-          - "The token used to identify at the REST-API. See
-            U(https://www.sophos.com/en-us/medialibrary/PDFs/documentation/UTMonAWS/Sophos-UTM-RESTful-API.pdf?la=en),
-            Chapter 2.4.2."
-        type: str
-        required: true
-    utm_protocol:
-        description:
-          - The protocol of the REST Endpoint.
-        choices: [ http, https ]
-        type: str
-        default: https
-    validate_certs:
-        description:
-          - Whether the REST interface's ssl certificate should be verified or not.
-        type: bool
-        default: true
-    state:
-        description:
-          - The desired state of the object.
-          - V(present) will create or update an object.
-          - V(absent) will delete an object if it was present.
-        type: str
-        choices: [ absent, present ]
-        default: present
-'''
+  headers:
+    description:
+      - A dictionary of additional headers to be sent to POST and PUT requests.
+      - Is needed for some modules.
+    type: dict
+    required: false
+    default: {}
+  utm_host:
+    description:
+      - The REST Endpoint of the Sophos UTM.
+    type: str
+    required: true
+  utm_port:
+    description:
+      - The port of the REST interface.
+    type: int
+    default: 4444
+  utm_token:
+    description:
+      - The token used to identify at the REST-API.
+      - See U(https://www.sophos.com/en-us/medialibrary/PDFs/documentation/UTMonAWS/Sophos-UTM-RESTful-API.pdf?la=en), Chapter 2.4.2.
+    type: str
+    required: true
+  utm_protocol:
+    description:
+      - The protocol of the REST Endpoint.
+    choices: [http, https]
+    type: str
+    default: https
+  validate_certs:
+    description:
+      - Whether the REST interface's SSL certificate should be verified or not.
+    type: bool
+    default: true
+  state:
+    description:
+      - The desired state of the object.
+      - V(present) will create or update an object.
+      - V(absent) will delete an object if it was present.
+    type: str
+    choices: [absent, present]
+    default: present
+"""

plugins/doc_fragments/vexata.py

@@ -10,14 +10,14 @@ __metaclass__ = type
 
 class ModuleDocFragment(object):
 
-    DOCUMENTATION = r'''
-options:
-    - See respective platform section for more details
+    DOCUMENTATION = r"""
+options: {}
+# See respective platform section for more details
 requirements:
-    - See respective platform section for more details
+  - See respective platform section for more details
 notes:
-    - Ansible modules are available for Vexata VX100 arrays.
-'''
+  - Ansible modules are available for Vexata VX100 arrays.
+"""
 
     # Documentation fragment for Vexata VX100 series
     VX100 = r'''

plugins/doc_fragments/xenserver.py

@@ -10,32 +10,33 @@ __metaclass__ = type
 
 class ModuleDocFragment(object):
     # Common parameters for XenServer modules
-    DOCUMENTATION = r'''
+    DOCUMENTATION = r"""
 options:
   hostname:
     description:
-    - The hostname or IP address of the XenServer host or XenServer pool master.
-    - If the value is not specified in the task, the value of environment variable E(XENSERVER_HOST) will be used instead.
+      - The hostname or IP address of the XenServer host or XenServer pool master.
+      - If the value is not specified in the task, the value of environment variable E(XENSERVER_HOST) will be used instead.
     type: str
     default: localhost
-    aliases: [ host, pool ]
+    aliases: [host, pool]
   username:
     description:
-    - The username to use for connecting to XenServer.
-    - If the value is not specified in the task, the value of environment variable E(XENSERVER_USER) will be used instead.
+      - The username to use for connecting to XenServer.
+      - If the value is not specified in the task, the value of environment variable E(XENSERVER_USER) will be used instead.
     type: str
     default: root
-    aliases: [ admin, user ]
+    aliases: [admin, user]
   password:
     description:
-    - The password to use for connecting to XenServer.
-    - If the value is not specified in the task, the value of environment variable E(XENSERVER_PASSWORD) will be used instead.
+      - The password to use for connecting to XenServer.
+      - If the value is not specified in the task, the value of environment variable E(XENSERVER_PASSWORD) will be used instead.
     type: str
-    aliases: [ pass, pwd ]
+    aliases: [pass, pwd]
   validate_certs:
     description:
-    - Allows connection when SSL certificates are not valid. Set to V(false) when certificates are not trusted.
-    - If the value is not specified in the task, the value of environment variable E(XENSERVER_VALIDATE_CERTS) will be used instead.
+      - Allows connection when SSL certificates are not valid. Set to V(false) when certificates are not trusted.
+      - If the value is not specified in the task, the value of environment variable E(XENSERVER_VALIDATE_CERTS) will be used
+        instead.
     type: bool
     default: true
-'''
+"""

plugins/lookup/dig.py

@@ -453,12 +453,7 @@ class LookupModule(LookupBase):
                     raise AnsibleError("Lookup failed: %s" % str(err))
                 if not real_empty:
                     ret.append('NXDOMAIN')
-            except dns.resolver.NoAnswer as err:
-                if fail_on_error:
-                    raise AnsibleError("Lookup failed: %s" % str(err))
-                if not real_empty:
-                    ret.append("")
-            except dns.resolver.Timeout as err:
+            except (dns.resolver.NoAnswer, dns.resolver.Timeout, dns.resolver.NoNameservers) as err:
                 if fail_on_error:
                     raise AnsibleError("Lookup failed: %s" % str(err))
                 if not real_empty:

plugins/module_utils/proxmox.py

@@ -8,6 +8,7 @@ from __future__ import absolute_import, division, print_function
 __metaclass__ = type
 
 import traceback
+from time import sleep
 
 PROXMOXER_IMP_ERR = None
 try:
@@ -70,6 +71,8 @@ def ansible_to_proxmox_bool(value):
 
 class ProxmoxAnsible(object):
     """Base class for Proxmox modules"""
+    TASK_TIMED_OUT = 'timeout expired'
+
     def __init__(self, module):
         if not HAS_PROXMOXER:
             module.fail_json(msg=missing_required_lib('proxmoxer'), exception=PROXMOXER_IMP_ERR)
@@ -167,6 +170,32 @@ class ProxmoxAnsible(object):
         except Exception as e:
             self.module.fail_json(msg='Unable to retrieve API task ID from node %s: %s' % (node, e))
 
+    def api_task_complete(self, node_name, task_id, timeout):
+        """Wait until the task stops or times out.
+
+        :param node_name: Proxmox node name where the task is running.
+        :param task_id: ID of the running task.
+        :param timeout: Timeout in seconds to wait for the task to complete.
+        :return: Task completion status (True/False) and ``exitstatus`` message when status=False.
+        """
+        status = {}
+        while timeout:
+            try:
+                status = self.proxmox_api.nodes(node_name).tasks(task_id).status.get()
+            except Exception as e:
+                self.module.fail_json(msg='Unable to retrieve API task ID from node %s: %s' % (node_name, e))
+
+            if status['status'] == 'stopped':
+                if status['exitstatus'] == 'OK':
+                    return True, None
+                else:
+                    return False, status['exitstatus']
+            else:
+                timeout -= 1
+                if timeout <= 0:
+                    return False, ProxmoxAnsible.TASK_TIMED_OUT
+                sleep(1)
+
     def get_pool(self, poolid):
         """Retrieve pool information
 

plugins/module_utils/redfish_utils.py

@@ -3588,7 +3588,7 @@ class RedfishUtils(object):
 
     def verify_bios_attributes(self, bios_attributes):
         # This method verifies BIOS attributes against the provided input
-        server_bios = self.get_multi_bios_attributes()
+        server_bios = self.get_bios_attributes(self.systems_uri)
         if server_bios["ret"] is False:
             return server_bios
 
@@ -3597,8 +3597,8 @@ class RedfishUtils(object):
 
         # Verify bios_attributes with BIOS settings available in the server
         for key, value in bios_attributes.items():
-            if key in server_bios["entries"][0][1]:
-                if server_bios["entries"][0][1][key] != value:
+            if key in server_bios["entries"]:
+                if server_bios["entries"][key] != value:
                     bios_dict.update({key: value})
             else:
                 wrong_param.update({key: value})

plugins/modules/gandi_livedns.py

@@ -8,15 +8,14 @@
 from __future__ import absolute_import, division, print_function
 __metaclass__ = type
 
-DOCUMENTATION = r'''
----
+DOCUMENTATION = r"""
 module: gandi_livedns
 author:
   - Gregory Thiemonge (@gthiemonge)
 version_added: "2.3.0"
 short_description: Manage Gandi LiveDNS records
 description:
-  - "Manages DNS records by the Gandi LiveDNS API, see the docs: U(https://doc.livedns.gandi.net/)."
+  - 'Manages DNS records by the Gandi LiveDNS API, see the docs: U(https://doc.livedns.gandi.net/).'
 extends_documentation_fragment:
   - community.general.attributes
 attributes:
@@ -27,32 +26,31 @@ attributes:
 options:
   personal_access_token:
     description:
-    - Scoped API token.
-    - One of O(personal_access_token) and O(api_key) must be specified.
+      - Scoped API token.
+      - One of O(personal_access_token) and O(api_key) must be specified.
     type: str
     version_added: 9.0.0
   api_key:
     description:
-    - Account API token.
-    - Note that these type of keys are deprecated and might stop working at some point.
-      Use personal access tokens instead.
-    - One of O(personal_access_token) and O(api_key) must be specified.
+      - Account API token.
+      - Note that these type of keys are deprecated and might stop working at some point. Use personal access tokens instead.
+      - One of O(personal_access_token) and O(api_key) must be specified.
     type: str
   record:
     description:
-    - Record to add.
+      - Record to add.
     type: str
     required: true
   state:
     description:
-    - Whether the record(s) should exist or not.
+      - Whether the record(s) should exist or not.
     type: str
-    choices: [ absent, present ]
+    choices: [absent, present]
     default: present
   ttl:
     description:
-    - The TTL to give the new record.
-    - Required when O(state=present).
+      - The TTL to give the new record.
+      - Required when O(state=present).
     type: int
   type:
     description:
@@ -61,25 +59,25 @@ options:
     required: true
   values:
     description:
-    - The record values.
-    - Required when O(state=present).
+      - The record values.
+      - Required when O(state=present).
     type: list
     elements: str
   domain:
     description:
-    - The name of the Domain to work with (for example, "example.com").
+      - The name of the Domain to work with (for example, V(example.com)).
     required: true
     type: str
-'''
+"""
 
-EXAMPLES = r'''
+EXAMPLES = r"""
 - name: Create a test A record to point to 127.0.0.1 in the my.com domain
   community.general.gandi_livedns:
     domain: my.com
     record: test
     type: A
     values:
-    - 127.0.0.1
+      - 127.0.0.1
     ttl: 7200
     personal_access_token: dummytoken
   register: record
@@ -90,7 +88,7 @@ EXAMPLES = r'''
     type: CNAME
     record: mail
     values:
-    - www
+      - www
     ttl: 7200
     personal_access_token: dummytoken
     state: present
@@ -101,7 +99,7 @@ EXAMPLES = r'''
     type: CNAME
     record: mail
     values:
-    - www
+      - www
     ttl: 10800
     personal_access_token: dummytoken
     state: present
@@ -120,46 +118,46 @@ EXAMPLES = r'''
     record: test
     type: A
     values:
-    - 127.0.0.1
+      - 127.0.0.1
     ttl: 7200
     api_key: dummyapikey
-'''
+"""
 
-RETURN = r'''
+RETURN = r"""
 record:
-    description: A dictionary containing the record data.
-    returned: success, except on record deletion
-    type: dict
-    contains:
-        values:
-            description: The record content (details depend on record type).
-            returned: success
-            type: list
-            elements: str
-            sample:
-            - 192.0.2.91
-            - 192.0.2.92
-        record:
-            description: The record name.
-            returned: success
-            type: str
-            sample: www
-        ttl:
-            description: The time-to-live for the record.
-            returned: success
-            type: int
-            sample: 300
-        type:
-            description: The record type.
-            returned: success
-            type: str
-            sample: A
-        domain:
-            description: The domain associated with the record.
-            returned: success
-            type: str
-            sample: my.com
-'''
+  description: A dictionary containing the record data.
+  returned: success, except on record deletion
+  type: dict
+  contains:
+    values:
+      description: The record content (details depend on record type).
+      returned: success
+      type: list
+      elements: str
+      sample:
+        - 192.0.2.91
+        - 192.0.2.92
+    record:
+      description: The record name.
+      returned: success
+      type: str
+      sample: www
+    ttl:
+      description: The time-to-live for the record.
+      returned: success
+      type: int
+      sample: 300
+    type:
+      description: The record type.
+      returned: success
+      type: str
+      sample: A
+    domain:
+      description: The domain associated with the record.
+      returned: success
+      type: str
+      sample: my.com
+"""
 
 
 from ansible.module_utils.basic import AnsibleModule

plugins/modules/gconftool2.py

@@ -9,21 +9,21 @@
 from __future__ import absolute_import, division, print_function
 __metaclass__ = type
 
-DOCUMENTATION = """
----
+DOCUMENTATION = r"""
 module: gconftool2
 author:
-- Kenneth D. Evensen (@kevensen)
+  - Kenneth D. Evensen (@kevensen)
 short_description: Edit GNOME Configurations
 description:
-- This module allows for the manipulation of GNOME 2 Configuration via gconftool-2.  Please see the gconftool-2(1) man pages for more details.
+  - This module allows for the manipulation of GNOME 2 Configuration using C(gconftool-2). Please see the gconftool-2(1) man pages
+    for more details.
 seealso:
-- name: C(gconftool-2) command manual page
-  description: Manual page for the command.
-  link: https://help.gnome.org/admin//system-admin-guide/2.32/gconf-6.html.en
+  - name: C(gconftool-2) command manual page
+    description: Manual page for the command.
+    link: https://help.gnome.org/admin//system-admin-guide/2.32/gconf-6.html.en
 
 extends_documentation_fragment:
-- community.general.attributes
+  - community.general.attributes
 attributes:
   check_mode:
     support: full
@@ -33,36 +33,37 @@ options:
   key:
     type: str
     description:
-    - A GConf preference key is an element in the GConf repository that corresponds to an application preference.
+      - A GConf preference key is an element in the GConf repository that corresponds to an application preference.
     required: true
   value:
     type: str
     description:
-    - Preference keys typically have simple values such as strings, integers, or lists of strings and integers. This is ignored unless O(state=present).
+      - Preference keys typically have simple values such as strings, integers, or lists of strings and integers. This is
+        ignored unless O(state=present).
   value_type:
     type: str
     description:
-    - The type of value being set. This is ignored unless O(state=present).
+      - The type of value being set. This is ignored unless O(state=present).
     choices: [bool, float, int, string]
   state:
     type: str
     description:
-    - The action to take upon the key/value.
+      - The action to take upon the key/value.
     required: true
     choices: [absent, present]
   config_source:
     type: str
     description:
-    - Specify a configuration source to use rather than the default path.
+      - Specify a configuration source to use rather than the default path.
   direct:
     description:
-    - Access the config database directly, bypassing server.  If O(direct) is specified then the O(config_source) must be specified as well.
+      - Access the config database directly, bypassing server. If O(direct) is specified then the O(config_source) must be
+        specified as well.
     type: bool
     default: false
 """
 
-EXAMPLES = """
----
+EXAMPLES = r"""
 - name: Change the widget font to "Serif 12"
   community.general.gconftool2:
     key: "/desktop/gnome/interface/font_name"
@@ -70,8 +71,7 @@ EXAMPLES = """
     value: "Serif 12"
 """
 
-RETURN = """
----
+RETURN = r"""
 key:
   description: The key specified in the module parameters.
   returned: success
@@ -84,15 +84,15 @@ value_type:
   sample: string
 value:
   description:
-  - The value of the preference key after executing the module or V(null) if key is removed.
-  - From community.general 7.0.0 onwards it returns V(null) for a non-existent O(key), and returned V("") before that.
+    - The value of the preference key after executing the module or V(null) if key is removed.
+    - From community.general 7.0.0 onwards it returns V(null) for a non-existent O(key), and returned V("") before that.
   returned: success
   type: str
   sample: "Serif 12"
 previous_value:
   description:
-  - The value of the preference key before executing the module.
-  - From community.general 7.0.0 onwards it returns V(null) for a non-existent O(key), and returned V("") before that.
+    - The value of the preference key before executing the module.
+    - From community.general 7.0.0 onwards it returns V(null) for a non-existent O(key), and returned V("") before that.
   returned: success
   type: str
   sample: "Serif 12"

plugins/modules/gconftool2_info.py

@@ -7,46 +7,43 @@
 from __future__ import absolute_import, division, print_function
 __metaclass__ = type
 
-DOCUMENTATION = """
----
+DOCUMENTATION = r"""
 module: gconftool2_info
 author:
-- "Alexei Znamensky (@russoz)"
+  - "Alexei Znamensky (@russoz)"
 short_description: Retrieve GConf configurations
 version_added: 5.1.0
 description:
-- This module allows retrieving application preferences from the GConf database, with the help of C(gconftool-2).
+  - This module allows retrieving application preferences from the GConf database, with the help of C(gconftool-2).
 extends_documentation_fragment:
-- community.general.attributes
-- community.general.attributes.info_module
+  - community.general.attributes
+  - community.general.attributes.info_module
 options:
   key:
     description:
-    - The key name for an element in the GConf database.
+      - The key name for an element in the GConf database.
     type: str
     required: true
 seealso:
-- name: C(gconftool-2) command manual page
-  description: Manual page for the command.
-  link: https://help.gnome.org/admin//system-admin-guide/2.32/gconf-6.html.en
-- name: gconf repository (archived)
-  description: Git repository for the project. It is an archived project, so the repository is read-only.
-  link: https://gitlab.gnome.org/Archive/gconf
+  - name: C(gconftool-2) command manual page
+    description: Manual page for the command.
+    link: https://help.gnome.org/admin//system-admin-guide/2.32/gconf-6.html.en
+  - name: gconf repository (archived)
+    description: Git repository for the project. It is an archived project, so the repository is read-only.
+    link: https://gitlab.gnome.org/Archive/gconf
 """
 
-EXAMPLES = """
----
+EXAMPLES = r"""
 - name: Get value for a certain key in the database.
   community.general.gconftool2_info:
     key: /desktop/gnome/background/picture_filename
   register: result
 """
 
-RETURN = """
----
+RETURN = r"""
 value:
   description:
-  - The value of the property.
+    - The value of the property.
   returned: success
   type: str
   sample: Monospace 10

plugins/modules/gem.py

@@ -9,8 +9,7 @@ from __future__ import absolute_import, division, print_function
 __metaclass__ = type
 
 
-DOCUMENTATION = '''
----
+DOCUMENTATION = r"""
 module: gem
 short_description: Manage Ruby gems
 description:
@@ -49,38 +48,37 @@ options:
   repository:
     type: str
     description:
-      - The repository from which the gem will be installed
+      - The repository from which the gem will be installed.
     required: false
     aliases: [source]
   user_install:
     description:
-      - Install gem in user's local gems cache or for all users
+      - Install gem in user's local gems cache or for all users.
     required: false
     type: bool
     default: true
   executable:
     type: path
     description:
-    - Override the path to the gem executable
+      - Override the path to the gem executable.
     required: false
   install_dir:
     type: path
     description:
-    - Install the gems into a specific directory.
-      These gems will be independent from the global installed ones.
-      Specifying this requires user_install to be false.
+      - Install the gems into a specific directory. These gems will be independent from the global installed ones. Specifying
+        this requires user_install to be false.
     required: false
   bindir:
     type: path
     description:
-    - Install executables into a specific directory.
+      - Install executables into a specific directory.
     version_added: 3.3.0
   norc:
     type: bool
     default: true
     description:
-    - Avoid loading any C(.gemrc) file. Ignored for RubyGems prior to 2.5.2.
-    - The default changed from V(false) to V(true) in community.general 6.0.0.
+      - Avoid loading any C(.gemrc) file. Ignored for RubyGems prior to 2.5.2.
+      - The default changed from V(false) to V(true) in community.general 6.0.0.
     version_added: 3.3.0
   env_shebang:
     description:
@@ -108,7 +106,7 @@ options:
   build_flags:
     type: str
     description:
-      - Allow adding build flags for gem compilation
+      - Allow adding build flags for gem compilation.
     required: false
   force:
     description:
@@ -117,11 +115,11 @@ options:
     default: false
     type: bool
 author:
-    - "Ansible Core Team"
-    - "Johan Wiren (@johanwiren)"
-'''
+  - "Ansible Core Team"
+  - "Johan Wiren (@johanwiren)"
+"""
 
-EXAMPLES = '''
+EXAMPLES = r"""
 - name: Install version 1.0 of vagrant
   community.general.gem:
     name: vagrant
@@ -138,7 +136,7 @@ EXAMPLES = '''
     name: rake
     gem_source: /path/to/gems/rake-1.0.gem
     state: present
-'''
+"""
 
 import re
 

plugins/modules/gio_mime.py

@@ -7,17 +7,17 @@
 from __future__ import absolute_import, division, print_function
 __metaclass__ = type
 
-DOCUMENTATION = """
----
+DOCUMENTATION = r"""
 module: gio_mime
 author:
-- "Alexei Znamensky (@russoz)"
+  - "Alexei Znamensky (@russoz)"
 short_description: Set default handler for MIME type, for applications using Gnome GIO
 version_added: 7.5.0
 description:
-- This module allows configuring the default handler for a specific MIME type, to be used by applications built with th Gnome GIO API.
+  - This module allows configuring the default handler for a specific MIME type, to be used by applications built with the
+    Gnome GIO API.
 extends_documentation_fragment:
-- community.general.attributes
+  - community.general.attributes
 attributes:
   check_mode:
     support: full
@@ -26,28 +26,27 @@ attributes:
 options:
   mime_type:
     description:
-    - MIME type for which a default handler will be set.
+      - MIME type for which a default handler will be set.
     type: str
     required: true
   handler:
     description:
-    - Default handler will be set for the MIME type.
+      - Default handler will be set for the MIME type.
     type: str
     required: true
 notes:
-- This module is a thin wrapper around the C(gio mime) command (and subcommand).
-- See man gio(1) for more details.
+  - This module is a thin wrapper around the C(gio mime) command (and subcommand).
+  - See man gio(1) for more details.
 seealso:
-- name: C(gio) command manual page
-  description: Manual page for the command.
-  link: https://man.archlinux.org/man/gio.1
-- name: GIO Documentation
-  description: Reference documentation for the GIO API..
-  link: https://docs.gtk.org/gio/
+  - name: C(gio) command manual page
+    description: Manual page for the command.
+    link: https://man.archlinux.org/man/gio.1
+  - name: GIO Documentation
+    description: Reference documentation for the GIO API..
+    link: https://docs.gtk.org/gio/
 """
 
-EXAMPLES = """
----
+EXAMPLES = r"""
 - name: Set chrome as the default handler for https
   community.general.gio_mime:
     mime_type: x-scheme-handler/https
@@ -55,23 +54,22 @@ EXAMPLES = """
   register: result
 """
 
-RETURN = """
----
+RETURN = r"""
 handler:
   description:
-  - The handler set as default.
+    - The handler set as default.
   returned: success
   type: str
   sample: google-chrome.desktop
 stdout:
   description:
-  - The output of the C(gio) command.
+    - The output of the C(gio) command.
   returned: success
   type: str
   sample: Set google-chrome.desktop as the default for x-scheme-handler/https
 stderr:
   description:
-  - The error output of the C(gio) command.
+    - The error output of the C(gio) command.
   returned: failure
   type: str
   sample: 'gio: Failed to load info for handler "never-existed.desktop"'

plugins/modules/git_config.py

@@ -11,8 +11,7 @@ from __future__ import absolute_import, division, print_function
 __metaclass__ = type
 
 
-DOCUMENTATION = '''
----
+DOCUMENTATION = r"""
 module: git_config
 author:
   - Matthew Gamble (@djmattyg007)
@@ -20,11 +19,10 @@ author:
 requirements: ['git']
 short_description: Update git configuration
 description:
-  - The M(community.general.git_config) module changes git configuration by invoking C(git config).
-    This is needed if you do not want to use M(ansible.builtin.template) for the entire git
-    config file (for example because you need to change just C(user.email) in
-    /etc/.git/config).  Solutions involving M(ansible.builtin.command) are cumbersome or
-    do not work correctly in check mode.
+  - The M(community.general.git_config) module changes git configuration by invoking C(git config). This is needed if you
+    do not want to use M(ansible.builtin.template) for the entire git config file (for example because you need to change
+    just C(user.email) in C(/etc/.git/config)). Solutions involving M(ansible.builtin.command) are cumbersome or do not work
+    correctly in check mode.
 extends_documentation_fragment:
   - community.general.attributes
 attributes:
@@ -36,19 +34,17 @@ options:
   list_all:
     description:
       - List all settings (optionally limited to a given O(scope)).
-      - This option is B(deprecated) and will be removed from community.general 11.0.0.
-        Please use M(community.general.git_config_info) instead.
+      - This option is B(deprecated) and will be removed from community.general 11.0.0. Please use M(community.general.git_config_info)
+        instead.
     type: bool
     default: false
   name:
     description:
-      - The name of the setting. If no value is supplied, the value will
-        be read from the config if it has been set.
+      - The name of the setting. If no value is supplied, the value will be read from the config if it has been set.
     type: str
   repo:
     description:
-      - Path to a git repository for reading and writing values from a
-        specific repo.
+      - Path to a git repository for reading and writing values from a specific repo.
     type: path
   file:
     description:
@@ -62,36 +58,34 @@ options:
       - If this is set to V(local), you must also specify the O(repo) parameter.
       - If this is set to V(file), you must also specify the O(file) parameter.
       - It defaults to system only when not using O(list_all=true).
-    choices: [ "file", "local", "global", "system" ]
+    choices: ["file", "local", "global", "system"]
     type: str
   state:
     description:
-      - "Indicates the setting should be set/unset.
-        This parameter has higher precedence than O(value) parameter:
-        when O(state=absent) and O(value) is defined, O(value) is discarded."
-    choices: [ 'present', 'absent' ]
+      - 'Indicates the setting should be set/unset. This parameter has higher precedence than O(value) parameter: when O(state=absent)
+        and O(value) is defined, O(value) is discarded.'
+    choices: ['present', 'absent']
     default: 'present'
     type: str
   value:
     description:
-      - When specifying the name of a single setting, supply a value to
-        set that setting to the given value.
-      - From community.general 11.0.0 on, O(value) will be required if O(state=present).
-        To read values, use the M(community.general.git_config_info) module instead.
+      - When specifying the name of a single setting, supply a value to set that setting to the given value.
+      - From community.general 11.0.0 on, O(value) will be required if O(state=present). To read values, use the M(community.general.git_config_info)
+        module instead.
     type: str
   add_mode:
     description:
-      - Specify if a value should replace the existing value(s) or if the new
-        value should be added alongside other values with the same name.
-      - This option is only relevant when adding/replacing values. If O(state=absent) or
-        values are just read out, this option is not considered.
-    choices: [ "add", "replace-all" ]
+      - Specify if a value should replace the existing value(s) or if the new value should be added alongside other values
+        with the same name.
+      - This option is only relevant when adding/replacing values. If O(state=absent) or values are just read out, this option
+        is not considered.
+    choices: ["add", "replace-all"]
     type: str
     default: "replace-all"
     version_added: 8.1.0
-'''
+"""
 
-EXAMPLES = '''
+EXAMPLES = r"""
 - name: Add a setting to ~/.gitconfig
   community.general.git_config:
     name: alias.ci
@@ -147,18 +141,17 @@ EXAMPLES = '''
     repo: /etc
     scope: local
     value: 'root@{{ ansible_fqdn }}'
-'''
+"""
 
-RETURN = '''
----
+RETURN = r"""
 config_value:
-  description: When O(list_all=false) and value is not set, a string containing the value of the setting in name
+  description: When O(list_all=false) and value is not set, a string containing the value of the setting in name.
   returned: success
   type: str
   sample: "vim"
 
 config_values:
-  description: When O(list_all=true), a dict containing key/value pairs of multiple configuration settings
+  description: When O(list_all=true), a dict containing key/value pairs of multiple configuration settings.
   returned: success
   type: dict
   sample:
@@ -166,7 +159,7 @@ config_values:
     color.ui: "auto"
     alias.diffc: "diff --cached"
     alias.remotev: "remote -v"
-'''
+"""
 
 from ansible.module_utils.basic import AnsibleModule
 

plugins/modules/git_config_info.py

@@ -10,8 +10,7 @@ from __future__ import absolute_import, division, print_function
 __metaclass__ = type
 
 
-DOCUMENTATION = '''
----
+DOCUMENTATION = r"""
 module: git_config_info
 author:
   - Guenther Grill (@guenhter)
@@ -19,8 +18,7 @@ version_added: 8.1.0
 requirements: ['git']
 short_description: Read git configuration
 description:
-  - The M(community.general.git_config_info) module reads the git configuration
-    by invoking C(git config).
+  - The M(community.general.git_config_info) module reads the git configuration by invoking C(git config).
 extends_documentation_fragment:
   - community.general.attributes
   - community.general.attributes.info_module
@@ -44,12 +42,12 @@ options:
       - If set to V(system), the system git config is used. O(path) is ignored.
       - If set to V(local), O(path) must be set to the repo to read from.
       - If set to V(file), O(path) must be set to the config file to read from.
-    choices: [ "global", "system", "local", "file" ]
+    choices: ["global", "system", "local", "file"]
     default: "system"
     type: str
-'''
+"""
 
-EXAMPLES = '''
+EXAMPLES = r"""
 - name: Read a system wide config
   community.general.git_config_info:
     name: core.editor
@@ -81,14 +79,13 @@ EXAMPLES = '''
   community.general.git_config_info:
     scope: file
     path: /etc/gitconfig
-'''
+"""
 
-RETURN = '''
----
+RETURN = r"""
 config_value:
-  description: >
-    When O(name) is set, a string containing the value of the setting in name. If O(name) is not set, empty.
-    If a config key such as V(push.pushoption) has more then one entry, just the first one is returned here.
+  description: >-
+    When O(name) is set, a string containing the value of the setting in name. If O(name) is not set, empty. If a config key
+    such as V(push.pushoption) has more then one entry, just the first one is returned here.
   returned: success if O(name) is set
   type: str
   sample: "vim"
@@ -97,8 +94,8 @@ config_values:
   description:
     - This is a dictionary mapping a git configuration setting to a list of its values.
     - When O(name) is not set, all configuration settings are returned here.
-    - When O(name) is set, only the setting specified in O(name) is returned here.
-      If that setting is not set, the key will still be present, and its value will be an empty list.
+    - When O(name) is set, only the setting specified in O(name) is returned here. If that setting is not set, the key will
+      still be present, and its value will be an empty list.
   returned: success
   type: dict
   sample:
@@ -106,7 +103,7 @@ config_values:
     color.ui: ["auto"]
     push.pushoption: ["merge_request.create", "merge_request.draft"]
     alias.remotev: ["remote -v"]
-'''
+"""
 
 from ansible.module_utils.basic import AnsibleModule
 

plugins/modules/github_deploy_key.py

@@ -9,15 +9,14 @@ from __future__ import absolute_import, division, print_function
 __metaclass__ = type
 
 
-DOCUMENTATION = '''
----
+DOCUMENTATION = r"""
 module: github_deploy_key
 author: "Ali (@bincyber)"
 short_description: Manages deploy keys for GitHub repositories
 description:
-  - "Adds or removes deploy keys for GitHub repositories. Supports authentication using username and password,
-  username and password and 2-factor authentication code (OTP), OAuth2 token, or personal access token. Admin
-  rights on the repository are required."
+  - Adds or removes deploy keys for GitHub repositories. Supports authentication using username and password, username and
+    password and 2-factor authentication code (OTP), OAuth2 token, or personal access token. Admin rights on the repository
+    are required.
 extends_documentation_fragment:
   - community.general.attributes
 attributes:
@@ -28,7 +27,7 @@ attributes:
 options:
   github_url:
     description:
-      - The base URL of the GitHub API
+      - The base URL of the GitHub API.
     required: false
     type: str
     version_added: '0.2.0'
@@ -37,19 +36,19 @@ options:
     description:
       - The name of the individual account or organization that owns the GitHub repository.
     required: true
-    aliases: [ 'account', 'organization' ]
+    aliases: ['account', 'organization']
     type: str
   repo:
     description:
       - The name of the GitHub repository.
     required: true
-    aliases: [ 'repository' ]
+    aliases: ['repository']
     type: str
   name:
     description:
       - The name for the deploy key.
     required: true
-    aliases: [ 'title', 'label' ]
+    aliases: ['title', 'label']
     type: str
   key:
     description:
@@ -58,14 +57,15 @@ options:
     type: str
   read_only:
     description:
-      - If V(true), the deploy key will only be able to read repository contents. Otherwise, the deploy key will be able to read and write.
+      - If V(true), the deploy key will only be able to read repository contents. Otherwise, the deploy key will be able to
+        read and write.
     type: bool
     default: true
   state:
     description:
       - The state of the deploy key.
     default: "present"
-    choices: [ "present", "absent" ]
+    choices: ["present", "absent"]
     type: str
   force:
     description:
@@ -74,11 +74,12 @@ options:
     default: false
   username:
     description:
-      - The username to authenticate with. Should not be set when using personal access token
+      - The username to authenticate with. Should not be set when using personal access token.
     type: str
   password:
     description:
-      - The password to authenticate with. Alternatively, a personal access token can be used instead of O(username) and O(password) combination.
+      - The password to authenticate with. Alternatively, a personal access token can be used instead of O(username) and O(password)
+        combination.
     type: str
   token:
     description:
@@ -89,10 +90,10 @@ options:
       - The 6 digit One Time Password for 2-Factor Authentication. Required together with O(username) and O(password).
     type: int
 notes:
-   - "Refer to GitHub's API documentation here: https://developer.github.com/v3/repos/keys/."
-'''
+  - "Refer to GitHub's API documentation here: https://developer.github.com/v3/repos/keys/."
+"""
 
-EXAMPLES = '''
+EXAMPLES = r"""
 - name: Add a new read-only deploy key to a GitHub repository using basic authentication
   community.general.github_deploy_key:
     owner: "johndoe"
@@ -152,33 +153,33 @@ EXAMPLES = '''
     read_only: true
     username: "janedoe"
     password: "supersecretpassword"
-'''
+"""
 
-RETURN = '''
+RETURN = r"""
 msg:
-    description: the status message describing what occurred
-    returned: always
-    type: str
-    sample: "Deploy key added successfully"
+  description: The status message describing what occurred.
+  returned: always
+  type: str
+  sample: "Deploy key added successfully"
 
 http_status_code:
-    description: the HTTP status code returned by the GitHub API
-    returned: failed
-    type: int
-    sample: 400
+  description: The HTTP status code returned by the GitHub API.
+  returned: failed
+  type: int
+  sample: 400
 
 error:
-    description: the error message returned by the GitHub API
-    returned: failed
-    type: str
-    sample: "key is already in use"
+  description: The error message returned by the GitHub API.
+  returned: failed
+  type: str
+  sample: "key is already in use"
 
 id:
-    description: the key identifier assigned by GitHub for the deploy key
-    returned: changed
-    type: int
-    sample: 24381901
-'''
+  description: The key identifier assigned by GitHub for the deploy key.
+  returned: changed
+  type: int
+  sample: 24381901
+"""
 
 from ansible.module_utils.basic import AnsibleModule
 from ansible.module_utils.urls import fetch_url

plugins/modules/github_issue.py

@@ -10,7 +10,7 @@ from __future__ import absolute_import, division, print_function
 __metaclass__ = type
 
 
-DOCUMENTATION = '''
+DOCUMENTATION = r"""
 module: github_issue
 short_description: View GitHub issue
 description:
@@ -40,24 +40,24 @@ options:
     type: int
   action:
     description:
-        - Get various details about issue depending upon action specified.
+      - Get various details about issue depending upon action specified.
     default: 'get_status'
     choices:
-        - 'get_status'
+      - get_status
     type: str
 author:
-    - Abhijeet Kasurde (@Akasurde)
-'''
+  - Abhijeet Kasurde (@Akasurde)
+"""
 
-RETURN = '''
+RETURN = r"""
 issue_status:
-    description: State of the GitHub issue
-    type: str
-    returned: success
-    sample: open, closed
-'''
+  description: State of the GitHub issue.
+  type: str
+  returned: success
+  sample: open, closed
+"""
 
-EXAMPLES = '''
+EXAMPLES = r"""
 - name: Check if GitHub issue is closed or not
   community.general.github_issue:
     organization: ansible
@@ -70,7 +70,7 @@ EXAMPLES = '''
   ansible.builtin.debug:
     msg: Do something when issue 23642 is open
   when: r.issue_status == 'open'
-'''
+"""
 
 import json
 

plugins/modules/github_key.py

@@ -9,7 +9,7 @@ from __future__ import absolute_import, division, print_function
 __metaclass__ = type
 
 
-DOCUMENTATION = '''
+DOCUMENTATION = r"""
 module: github_key
 short_description: Manage GitHub access keys
 description:
@@ -29,7 +29,7 @@ options:
     type: str
   name:
     description:
-      - SSH key name
+      - SSH key name.
     required: true
     type: str
   pubkey:
@@ -44,34 +44,36 @@ options:
     type: str
   force:
     description:
-      - The default is V(true), which will replace the existing remote key
-        if it is different than O(pubkey). If V(false), the key will only be
-        set if no key with the given O(name) exists.
+      - The default is V(true), which will replace the existing remote key if it is different than O(pubkey). If V(false),
+        the key will only be set if no key with the given O(name) exists.
     type: bool
     default: true
 
 author: Robert Estelle (@erydo)
-'''
+"""
 
-RETURN = '''
+RETURN = r"""
 deleted_keys:
-    description: An array of key objects that were deleted. Only present on state=absent
-    type: list
-    returned: When state=absent
-    sample: [{'id': 0, 'key': 'BASE64 encoded key', 'url': 'http://example.com/github key', 'created_at': 'YYYY-MM-DDTHH:MM:SZ', 'read_only': false}]
+  description: An array of key objects that were deleted. Only present on state=absent.
+  type: list
+  returned: When state=absent
+  sample: [{'id': 0, 'key': 'BASE64 encoded key', 'url': 'http://example.com/github key', 'created_at': 'YYYY-MM-DDTHH:MM:SZ',
+        'read_only': false}]
 matching_keys:
-    description: An array of keys matching the specified name. Only present on state=present
-    type: list
-    returned: When state=present
-    sample: [{'id': 0, 'key': 'BASE64 encoded key', 'url': 'http://example.com/github key', 'created_at': 'YYYY-MM-DDTHH:MM:SZ', 'read_only': false}]
+  description: An array of keys matching the specified name. Only present on state=present.
+  type: list
+  returned: When state=present
+  sample: [{'id': 0, 'key': 'BASE64 encoded key', 'url': 'http://example.com/github key', 'created_at': 'YYYY-MM-DDTHH:MM:SZ',
+        'read_only': false}]
 key:
-    description: Metadata about the key just created. Only present on state=present
-    type: dict
-    returned: success
-    sample: {'id': 0, 'key': 'BASE64 encoded key', 'url': 'http://example.com/github key', 'created_at': 'YYYY-MM-DDTHH:MM:SZ', 'read_only': false}
-'''
+  description: Metadata about the key just created. Only present on state=present.
+  type: dict
+  returned: success
+  sample: {'id': 0, 'key': 'BASE64 encoded key', 'url': 'http://example.com/github key', 'created_at': 'YYYY-MM-DDTHH:MM:SZ',
+    'read_only': false}
+"""
 
-EXAMPLES = '''
+EXAMPLES = r"""
 - name: Read SSH public key to authorize
   ansible.builtin.shell: cat /home/foo/.ssh/id_rsa.pub
   register: ssh_pub_key
@@ -89,7 +91,7 @@ EXAMPLES = '''
     name: Access Key for Some Machine
     token: '{{ github_access_token }}'
     pubkey: "{{ lookup('ansible.builtin.file', '/home/foo/.ssh/id_rsa.pub') }}"
-'''
+"""
 
 import datetime
 import json

plugins/modules/github_release.py

@@ -9,78 +9,77 @@ from __future__ import absolute_import, division, print_function
 __metaclass__ = type
 
 
-DOCUMENTATION = '''
----
+DOCUMENTATION = r"""
 module: github_release
 short_description: Interact with GitHub Releases
 description:
-    - Fetch metadata about GitHub Releases
+  - Fetch metadata about GitHub Releases.
 extends_documentation_fragment:
-    - community.general.attributes
+  - community.general.attributes
 attributes:
-    check_mode:
-        support: full
-    diff_mode:
-        support: none
+  check_mode:
+    support: full
+  diff_mode:
+    support: none
 options:
-    token:
-        description:
-            - GitHub Personal Access Token for authenticating. Mutually exclusive with O(password).
-        type: str
-    user:
-        description:
-            - The GitHub account that owns the repository
-        type: str
-        required: true
-    password:
-        description:
-            - The GitHub account password for the user. Mutually exclusive with O(token).
-        type: str
-    repo:
-        description:
-            - Repository name
-        type: str
-        required: true
-    action:
-        description:
-            - Action to perform
-        type: str
-        required: true
-        choices: [ 'latest_release', 'create_release' ]
-    tag:
-        description:
-            - Tag name when creating a release. Required when using O(action=create_release).
-        type: str
-    target:
-        description:
-            - Target of release when creating a release
-        type: str
-    name:
-        description:
-            - Name of release when creating a release
-        type: str
-    body:
-        description:
-            - Description of the release when creating a release
-        type: str
-    draft:
-        description:
-            - Sets if the release is a draft or not. (boolean)
-        type: bool
-        default: false
-    prerelease:
-        description:
-            - Sets if the release is a prerelease or not. (boolean)
-        type: bool
-        default: false
+  token:
+    description:
+      - GitHub Personal Access Token for authenticating. Mutually exclusive with O(password).
+    type: str
+  user:
+    description:
+      - The GitHub account that owns the repository.
+    type: str
+    required: true
+  password:
+    description:
+      - The GitHub account password for the user. Mutually exclusive with O(token).
+    type: str
+  repo:
+    description:
+      - Repository name.
+    type: str
+    required: true
+  action:
+    description:
+      - Action to perform.
+    type: str
+    required: true
+    choices: ['latest_release', 'create_release']
+  tag:
+    description:
+      - Tag name when creating a release. Required when using O(action=create_release).
+    type: str
+  target:
+    description:
+      - Target of release when creating a release.
+    type: str
+  name:
+    description:
+      - Name of release when creating a release.
+    type: str
+  body:
+    description:
+      - Description of the release when creating a release.
+    type: str
+  draft:
+    description:
+      - Sets if the release is a draft or not. (boolean).
+    type: bool
+    default: false
+  prerelease:
+    description:
+      - Sets if the release is a prerelease or not. (boolean).
+    type: bool
+    default: false
 
 author:
-    - "Adrian Moisey (@adrianmoisey)"
+  - "Adrian Moisey (@adrianmoisey)"
 requirements:
-    - "github3.py >= 1.0.0a3"
-'''
+  - "github3.py >= 1.0.0a3"
+"""
 
-EXAMPLES = '''
+EXAMPLES = r"""
 - name: Get latest release of a public repository
   community.general.github_release:
     user: ansible
@@ -111,16 +110,15 @@ EXAMPLES = '''
     target: master
     name: My Release
     body: Some description
+"""
 
-'''
-
-RETURN = '''
+RETURN = r"""
 tag:
-    description: Version of the created/latest release.
-    type: str
-    returned: success
-    sample: 1.1.0
-'''
+  description: Version of the created/latest release.
+  type: str
+  returned: success
+  sample: 1.1.0
+"""
 
 import traceback
 

plugins/modules/github_repo.py

@@ -8,8 +8,7 @@
 from __future__ import absolute_import, division, print_function
 __metaclass__ = type
 
-DOCUMENTATION = '''
----
+DOCUMENTATION = r"""
 module: github_repo
 short_description: Manage your repositories on Github
 version_added: 2.2.0
@@ -26,81 +25,82 @@ attributes:
 options:
   username:
     description:
-    - Username used for authentication.
-    - This is only needed when not using O(access_token).
+      - Username used for authentication.
+      - This is only needed when not using O(access_token).
     type: str
     required: false
   password:
     description:
-    - Password used for authentication.
-    - This is only needed when not using O(access_token).
+      - Password used for authentication.
+      - This is only needed when not using O(access_token).
     type: str
     required: false
   access_token:
     description:
-    - Token parameter for authentication.
-    - This is only needed when not using O(username) and O(password).
+      - Token parameter for authentication.
+      - This is only needed when not using O(username) and O(password).
     type: str
     required: false
   name:
     description:
-    - Repository name.
+      - Repository name.
     type: str
     required: true
   description:
     description:
-    - Description for the repository.
-    - Defaults to empty if O(force_defaults=true), which is the default in this module.
-    - Defaults to empty if O(force_defaults=false) when creating a new repository.
-    - This is only used when O(state) is V(present).
+      - Description for the repository.
+      - Defaults to empty if O(force_defaults=true), which is the default in this module.
+      - Defaults to empty if O(force_defaults=false) when creating a new repository.
+      - This is only used when O(state) is V(present).
     type: str
     required: false
   private:
     description:
-    - Whether the repository should be private or not.
-    - Defaults to V(false) if O(force_defaults=true), which is the default in this module.
-    - Defaults to V(false) if O(force_defaults=false) when creating a new repository.
-    - This is only used when O(state=present).
+      - Whether the repository should be private or not.
+      - Defaults to V(false) if O(force_defaults=true), which is the default in this module.
+      - Defaults to V(false) if O(force_defaults=false) when creating a new repository.
+      - This is only used when O(state=present).
     type: bool
     required: false
   state:
     description:
-    - Whether the repository should exist or not.
+      - Whether the repository should exist or not.
     type: str
     default: present
-    choices: [ absent, present ]
+    choices: [absent, present]
     required: false
   organization:
     description:
-    - Organization for the repository.
-    - When O(state=present), the repository will be created in the current user profile.
+      - Organization for the repository.
+      - When O(state=present), the repository will be created in the current user profile.
     type: str
     required: false
   api_url:
     description:
-    - URL to the GitHub API if not using github.com but you own instance.
+      - URL to the GitHub API if not using github.com but you own instance.
     type: str
     default: 'https://api.github.com'
     version_added: "3.5.0"
   force_defaults:
     description:
-    - Overwrite current O(description) and O(private) attributes with defaults if set to V(true), which currently is the default.
-    - The default for this option will be deprecated in a future version of this collection, and eventually change to V(false).
+      - Overwrite current O(description) and O(private) attributes with defaults if set to V(true), which currently is the
+        default.
+      - The default for this option will be deprecated in a future version of this collection, and eventually change to V(false).
     type: bool
     default: true
     required: false
     version_added: 4.1.0
 requirements:
-- PyGithub>=1.54
+  - PyGithub>=1.54
 notes:
-- For Python 3, PyGithub>=1.54 should be used.
-- "For Python 3.5, PyGithub==1.54 should be used. More information: U(https://pygithub.readthedocs.io/en/latest/changes.html#version-1-54-november-30-2020)."
-- "For Python 2.7, PyGithub==1.45 should be used. More information: U(https://pygithub.readthedocs.io/en/latest/changes.html#version-1-45-december-29-2019)."
+  - For Python 3, PyGithub>=1.54 should be used.
+  - 'For Python 3.5, PyGithub==1.54 should be used. More information: U(https://pygithub.readthedocs.io/en/latest/changes.html#version-1-54-november-30-2020).'
+  - 'For Python 2.7, PyGithub==1.45 should be used. More information: U(https://pygithub.readthedocs.io/en/latest/changes.html#version-1-45-december-29-2019).'
 author:
-- Álvaro Torres Cogollo (@atorrescogollo)
-'''
+  - Álvaro Torres Cogollo (@atorrescogollo)
+"""
 
-EXAMPLES = '''
+EXAMPLES = r"""
 - name: Create a Github repository
   community.general.github_repo:
     access_token: mytoken
@@ -120,14 +120,14 @@ EXAMPLES = '''
     name: myrepo
     state: absent
   register: result
-'''
+"""
 
-RETURN = '''
+RETURN = r"""
 repo:
   description: Repository information as JSON. See U(https://docs.github.com/en/rest/reference/repos#get-a-repository).
   returned: success and O(state=present)
   type: dict
-'''
+"""
 
 import traceback
 from ansible.module_utils.basic import AnsibleModule, missing_required_lib

plugins/modules/github_webhook.py

@@ -8,12 +8,11 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = '''
----
+DOCUMENTATION = r"""
 module: github_webhook
 short_description: Manage GitHub webhooks
 description:
-  - "Create and delete GitHub webhooks"
+  - Create and delete GitHub webhooks.
 requirements:
   - "PyGithub >= 1.3.5"
 extends_documentation_fragment:
@@ -26,22 +25,22 @@ attributes:
 options:
   repository:
     description:
-      - Full name of the repository to configure a hook for
+      - Full name of the repository to configure a hook for.
     type: str
     required: true
     aliases:
       - repo
   url:
     description:
-      - URL to which payloads will be delivered
+      - URL to which payloads will be delivered.
     type: str
     required: true
   content_type:
     description:
-      - The media type used to serialize the payloads
+      - The media type used to serialize the payloads.
     type: str
     required: false
-    choices: [ form, json ]
+    choices: [form, json]
     default: form
   secret:
     description:
@@ -50,61 +49,57 @@ options:
     required: false
   insecure_ssl:
     description:
-      - >
-        Flag to indicate that GitHub should skip SSL verification when calling
-        the hook.
+      - Flag to indicate that GitHub should skip SSL verification when calling the hook.
     required: false
     type: bool
     default: false
   events:
     description:
-      - >
-        A list of GitHub events the hook is triggered for. Events are listed at
-        U(https://developer.github.com/v3/activity/events/types/). Required
-        unless O(state=absent)
+      - A list of GitHub events the hook is triggered for. Events are listed at U(https://developer.github.com/v3/activity/events/types/).
+        Required unless O(state=absent).
     required: false
     type: list
     elements: str
   active:
     description:
-      - Whether or not the hook is active
+      - Whether or not the hook is active.
     required: false
     type: bool
     default: true
   state:
     description:
-      - Whether the hook should be present or absent
+      - Whether the hook should be present or absent.
     type: str
     required: false
-    choices: [ absent, present ]
+    choices: [absent, present]
     default: present
   user:
     description:
-      - User to authenticate to GitHub as
+      - User to authenticate to GitHub as.
     type: str
     required: true
   password:
     description:
-      - Password to authenticate to GitHub with
+      - Password to authenticate to GitHub with.
     type: str
     required: false
   token:
     description:
-      - Token to authenticate to GitHub with
+      - Token to authenticate to GitHub with.
     type: str
     required: false
   github_url:
     description:
-      - Base URL of the GitHub API
+      - Base URL of the GitHub API.
     type: str
     required: false
     default: https://api.github.com
 
 author:
   - "Chris St. Pierre (@stpierre)"
-'''
+"""
 
-EXAMPLES = '''
+EXAMPLES = r"""
 - name: Create a new webhook that triggers on push (password auth)
   community.general.github_webhook:
     repository: ansible/ansible
@@ -135,16 +130,15 @@ EXAMPLES = '''
     state: absent
     user: "{{ github_user }}"
     password: "{{ github_password }}"
-'''
+"""
 
-RETURN = '''
----
+RETURN = r"""
 hook_id:
-  description: The GitHub ID of the hook created/updated
+  description: The GitHub ID of the hook created/updated.
   returned: when state is 'present'
   type: int
   sample: 6206
-'''
+"""
 
 import traceback
 

plugins/modules/github_webhook_info.py

@@ -8,12 +8,11 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-DOCUMENTATION = '''
----
+DOCUMENTATION = r"""
 module: github_webhook_info
 short_description: Query information about GitHub webhooks
 description:
-  - "Query information about GitHub webhooks"
+  - Query information about GitHub webhooks.
 requirements:
   - "PyGithub >= 1.3.5"
 extends_documentation_fragment:
@@ -22,38 +21,38 @@ extends_documentation_fragment:
 options:
   repository:
     description:
-      - Full name of the repository to configure a hook for
+      - Full name of the repository to configure a hook for.
     type: str
     required: true
     aliases:
       - repo
   user:
     description:
-      - User to authenticate to GitHub as
+      - User to authenticate to GitHub as.
     type: str
     required: true
   password:
     description:
-      - Password to authenticate to GitHub with
+      - Password to authenticate to GitHub with.
     type: str
     required: false
   token:
     description:
-      - Token to authenticate to GitHub with
+      - Token to authenticate to GitHub with.
     type: str
     required: false
   github_url:
     description:
-      - Base URL of the github api
+      - Base URL of the GitHub API.
     type: str
     required: false
     default: https://api.github.com
 
 author:
   - "Chris St. Pierre (@stpierre)"
-'''
+"""
 
-EXAMPLES = '''
+EXAMPLES = r"""
 - name: List hooks for a repository (password auth)
   community.general.github_webhook_info:
     repository: ansible/ansible
@@ -68,12 +67,11 @@ EXAMPLES = '''
     token: "{{ github_user_api_token }}"
     github_url: https://github.example.com/api/v3/
   register: myrepo_webhooks
-'''
+"""
 
-RETURN = '''
----
+RETURN = r"""
 hooks:
-  description: A list of hooks that exist for the repo
+  description: A list of hooks that exist for the repo.
   returned: always
   type: list
   elements: dict
@@ -88,7 +86,7 @@ hooks:
         "id": 6206,
         "last_response": {"status": "active", "message": "OK", "code": 200}
       }
-'''
+"""
 
 import traceback
 

plugins/modules/gitlab_branch.py

@@ -7,7 +7,7 @@
 from __future__ import absolute_import, division, print_function
 __metaclass__ = type
 
-DOCUMENTATION = '''
+DOCUMENTATION = r"""
 module: gitlab_branch
 short_description: Create or delete a branch
 version_added: 4.2.0
@@ -50,10 +50,10 @@ options:
       - Reference branch to create from.
       - This must be specified if O(state=present).
     type: str
-'''
+"""
 
 
-EXAMPLES = '''
+EXAMPLES = r"""
 - name: Create branch branch2 from main
   community.general.gitlab_branch:
     api_url: https://gitlab.com
@@ -70,11 +70,10 @@ EXAMPLES = '''
     project: "group1/project1"
     branch: branch2
     state: absent
+"""
 
-'''
-
-RETURN = '''
-'''
+RETURN = r"""
+"""
 
 import traceback
 

plugins/modules/gitlab_deploy_key.py

@@ -11,11 +11,11 @@
 from __future__ import absolute_import, division, print_function
 __metaclass__ = type
 
-DOCUMENTATION = '''
+DOCUMENTATION = r"""
 module: gitlab_deploy_key
 short_description: Manages GitLab project deploy keys
 description:
-  - Adds, updates and removes project deploy keys
+  - Adds, updates and removes project deploy keys.
 author:
   - Marcus Watkins (@marwatk)
   - Guillaume Martinez (@Lunik)
@@ -45,7 +45,7 @@ options:
     type: str
   key:
     description:
-      - Deploy key
+      - Deploy key.
     required: true
     type: str
   can_push:
@@ -55,14 +55,14 @@ options:
     default: false
   state:
     description:
-      - When V(present) the deploy key added to the project if it doesn't exist.
+      - When V(present) the deploy key added to the project if it does not exist.
       - When V(absent) it will be removed from the project if it exists.
     default: present
     type: str
-    choices: [ "present", "absent" ]
-'''
+    choices: ["present", "absent"]
+"""
 
-EXAMPLES = '''
+EXAMPLES = r"""
 - name: "Adding a project deploy key"
   community.general.gitlab_deploy_key:
     api_url: https://gitlab.example.com/
@@ -88,32 +88,31 @@ EXAMPLES = '''
     project: "my_group/my_project"
     state: absent
     key: "ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAIEAiPWx6WM4lhHNedGfBpPJNPpZ7yKu+dnn1SJejgt4596k6YjzGGphH2TUxwKzxcKDKKezwkpfnxPkSMkuEspGRt/aZZ9w..."
+"""
 
-'''
-
-RETURN = '''
+RETURN = r"""
 msg:
-  description: Success or failure message
+  description: Success or failure message.
   returned: always
   type: str
   sample: "Success"
 
 result:
-  description: json parsed response from the server
+  description: JSON-parsed response from the server.
   returned: always
   type: dict
 
 error:
-  description: the error message returned by the GitLab API
+  description: The error message returned by the GitLab API.
   returned: failed
   type: str
   sample: "400: key is already in use"
 
 deploy_key:
-  description: API object
+  description: API object.
   returned: always
   type: dict
-'''
+"""
 
 from ansible.module_utils.api import basic_auth_argument_spec
 from ansible.module_utils.basic import AnsibleModule

plugins/modules/gitlab_group.py

@@ -9,8 +9,7 @@
 from __future__ import absolute_import, division, print_function
 __metaclass__ = type
 
-DOCUMENTATION = '''
----
+DOCUMENTATION = r"""
 module: gitlab_group
 short_description: Creates/updates/deletes GitLab Groups
 description:
@@ -97,12 +96,12 @@ options:
     type: str
   parent:
     description:
-      - Allow to create subgroups
-      - Id or Full path of parent group in the form of group/name
+      - Allow to create subgroups.
+      - Id or Full path of parent group in the form of group/name.
     type: str
   path:
     description:
-      - The path of the group you want to create, this will be api_url/group_path
+      - The path of the group you want to create, this will be api_url/group_path.
       - If not supplied, the group_name will be used.
     type: str
   prevent_forking_outside_group:
@@ -146,7 +145,7 @@ options:
     version_added: 3.7.0
   state:
     description:
-      - create or delete group.
+      - Create or delete group.
       - Possible values are present and absent.
     default: present
     type: str
@@ -164,7 +163,7 @@ options:
     version_added: 9.5.0
   visibility:
     description:
-      - Default visibility of the group
+      - Default visibility of the group.
     choices: ["private", "internal", "public"]
     default: private
     type: str
@@ -176,9 +175,9 @@ options:
     choices: ["enabled", "private", "disabled"]
     type: str
     version_added: 9.5.0
-'''
+"""
 
-EXAMPLES = '''
+EXAMPLES = r"""
 - name: "Delete GitLab Group"
   community.general.gitlab_group:
     api_url: https://gitlab.example.com/
@@ -221,31 +220,31 @@ EXAMPLES = '''
     project_creation_level: noone
     auto_devops_enabled: false
     subgroup_creation_level: maintainer
-'''
+"""
 
-RETURN = '''
+RETURN = r"""
 msg:
-  description: Success or failure message
+  description: Success or failure message.
   returned: always
   type: str
   sample: "Success"
 
 result:
-  description: json parsed response from the server
+  description: JSON-parsed response from the server.
   returned: always
   type: dict
 
 error:
-  description: the error message returned by the GitLab API
+  description: The error message returned by the GitLab API.
   returned: failed
   type: str
   sample: "400: path is already in use"
 
 group:
-  description: API object
+  description: API object.
   returned: always
   type: dict
-'''
+"""
 
 from ansible.module_utils.api import basic_auth_argument_spec
 from ansible.module_utils.basic import AnsibleModule

plugins/modules/gitlab_group_access_token.py

@@ -12,7 +12,7 @@
 from __future__ import absolute_import, division, print_function
 __metaclass__ = type
 
-DOCUMENTATION = r'''
+DOCUMENTATION = r"""
 module: gitlab_group_access_token
 short_description: Manages GitLab group access tokens
 version_added: 8.4.0
@@ -27,11 +27,10 @@ extends_documentation_fragment:
   - community.general.gitlab
   - community.general.attributes
 notes:
-  - Access tokens can not be changed. If a parameter needs to be changed, an acceess token has to be recreated.
-    Whether tokens will be recreated is controlled by the O(recreate) option, which defaults to V(never).
+  - Access tokens can not be changed. If a parameter needs to be changed, an acceess token has to be recreated. Whether tokens
+    will be recreated is controlled by the O(recreate) option, which defaults to V(never).
   - Token string is contained in the result only when access token is created or recreated. It can not be fetched afterwards.
   - Token matching is done by comparing O(name) option.
-
 attributes:
   check_mode:
     support: full
@@ -56,7 +55,8 @@ options:
     type: list
     elements: str
     aliases: ["scope"]
-    choices: ["api", "read_api", "read_registry", "write_registry", "read_repository", "write_repository", "create_runner", "ai_features", "k8s_proxy"]
+    choices: ["api", "read_api", "read_registry", "write_registry", "read_repository", "write_repository", "create_runner",
+      "ai_features", "k8s_proxy"]
   access_level:
     description:
       - Access level of the access token.
@@ -84,10 +84,10 @@ options:
       - When V(absent) it will be removed from the group if it exists.
     default: present
     type: str
-    choices: [ "present", "absent" ]
-'''
+    choices: ["present", "absent"]
+"""
 
-EXAMPLES = r'''
+EXAMPLES = r"""
 - name: "Creating a group access token"
   community.general.gitlab_group_access_token:
     api_url: https://gitlab.example.com/
@@ -131,16 +131,16 @@ EXAMPLES = r'''
       - write_repository
     recreate: state_change
     state: present
-'''
+"""
 
-RETURN = r'''
+RETURN = r"""
 access_token:
   description:
     - API object.
     - Only contains the value of the token if the token was created or recreated.
   returned: success and O(state=present)
   type: dict
-'''
+"""
 
 from datetime import datetime
 

plugins/modules/gitlab_group_members.py

@@ -8,8 +8,7 @@
 from __future__ import absolute_import, division, print_function
 __metaclass__ = type
 
-DOCUMENTATION = r'''
----
+DOCUMENTATION = r"""
 module: gitlab_group_members
 short_description: Manage group members on GitLab Server
 description:
@@ -81,16 +80,16 @@ options:
     type: str
   purge_users:
     description:
-      - Adds/remove users of the given access_level to match the given O(gitlab_user)/O(gitlab_users_access) list.
-        If omitted do not purge orphaned members.
+      - Adds/remove users of the given access_level to match the given O(gitlab_user)/O(gitlab_users_access) list. If omitted
+        do not purge orphaned members.
       - Is only used when O(state=present).
     type: list
     elements: str
     choices: ['guest', 'reporter', 'developer', 'maintainer', 'owner']
     version_added: 3.6.0
-'''
+"""
 
-EXAMPLES = r'''
+EXAMPLES = r"""
 - name: Add a user to a GitLab Group
   community.general.gitlab_group_members:
     api_url: 'https://gitlab.example.com'
@@ -152,9 +151,9 @@ EXAMPLES = r'''
       - name: user2
         access_level: maintainer
     state: absent
-'''
+"""
 
-RETURN = r''' # '''
+RETURN = r""" # """
 
 from ansible.module_utils.api import basic_auth_argument_spec
 from ansible.module_utils.basic import AnsibleModule

plugins/modules/gitlab_group_variable.py

@@ -9,15 +9,15 @@
 from __future__ import absolute_import, division, print_function
 __metaclass__ = type
 
-DOCUMENTATION = r'''
+DOCUMENTATION = r"""
 module: gitlab_group_variable
 short_description: Creates, updates, or deletes GitLab groups variables
 version_added: 1.2.0
 description:
   - Creates a group variable if it does not exist.
   - When a group variable does exist, its value will be updated when the values are different.
-  - Variables which are untouched in the playbook, but are not untouched in the GitLab group,
-    they stay untouched (O(purge=false)) or will be deleted (O(purge=true)).
+  - Variables which are untouched in the playbook, but are not untouched in the GitLab group, they stay untouched (O(purge=false))
+    or will be deleted (O(purge=true)).
 author:
   - Florent Madiot (@scodeman)
 requirements:
@@ -53,8 +53,8 @@ options:
   vars:
     description:
       - When the list element is a simple key-value pair, masked, raw and protected will be set to false.
-      - When the list element is a dict with the keys C(value), C(masked), C(raw) and C(protected), the user can
-        have full control about whether a value should be masked, raw, protected or both.
+      - When the list element is a dict with the keys C(value), C(masked), C(raw) and C(protected), the user can have full
+        control about whether a value should be masked, raw, protected or both.
       - Support for group variables requires GitLab >= 9.5.
       - Support for environment_scope requires GitLab Premium >= 13.11.
       - Support for protected values requires GitLab >= 9.3.
@@ -62,8 +62,8 @@ options:
       - Support for raw values requires GitLab >= 15.7.
       - A C(value) must be a string or a number.
       - Field C(variable_type) must be a string with either V(env_var), which is the default, or V(file).
-      - When a value is masked, it must be in Base64 and have a length of at least 8 characters.
-        See GitLab documentation on acceptable values for a masked variable (U(https://docs.gitlab.com/ce/ci/variables/#masked-variables)).
+      - When a value is masked, it must be in Base64 and have a length of at least 8 characters. See GitLab documentation
+        on acceptable values for a masked variable (U(https://docs.gitlab.com/ce/ci/variables/#masked-variables)).
     default: {}
     type: dict
   variables:
@@ -106,17 +106,17 @@ options:
         description:
           - Whether a variable is an environment variable (V(env_var)) or a file (V(file)).
         type: str
-        choices: [ "env_var", "file" ]
+        choices: ["env_var", "file"]
         default: env_var
       environment_scope:
         description:
           - The scope for the variable.
         type: str
         default: '*'
-'''
+"""
 
 
-EXAMPLES = r'''
+EXAMPLES = r"""
 - name: Set or update some CI/CD variables
   community.general.gitlab_group_variable:
     api_url: https://gitlab.com
@@ -173,9 +173,9 @@ EXAMPLES = r'''
     state: absent
     vars:
       ACCESS_KEY_ID: abc123
-'''
+"""
 
-RETURN = r'''
+RETURN = r"""
 group_variable:
   description: Four lists of the variablenames which were added, updated, removed or exist.
   returned: always
@@ -201,7 +201,7 @@ group_variable:
       returned: always
       type: list
       sample: ['ACCESS_KEY_ID', 'SECRET_ACCESS_KEY']
-'''
+"""
 
 from ansible.module_utils.basic import AnsibleModule
 from ansible.module_utils.api import basic_auth_argument_spec

plugins/modules/gitlab_hook.py

@@ -11,12 +11,11 @@
 from __future__ import absolute_import, division, print_function
 __metaclass__ = type
 
-DOCUMENTATION = '''
----
+DOCUMENTATION = r"""
 module: gitlab_hook
 short_description: Manages GitLab project hooks
 description:
-  - Adds, updates and removes project hook
+  - Adds, updates and removes project hook.
 author:
   - Marcus Watkins (@marwatk)
   - Guillaume Martinez (@Lunik)
@@ -46,11 +45,11 @@ options:
     type: str
   state:
     description:
-      - When V(present) the hook will be updated to match the input or created if it doesn't exist.
+      - When V(present) the hook will be updated to match the input or created if it does not exist.
       - When V(absent) hook will be deleted if it exists.
     default: present
     type: str
-    choices: [ "present", "absent" ]
+    choices: ["present", "absent"]
   push_events:
     description:
       - Trigger hook on push events.
@@ -58,7 +57,7 @@ options:
     default: true
   push_events_branch_filter:
     description:
-      - Branch name of wildcard to trigger hook on push events
+      - Branch name of wildcard to trigger hook on push events.
     type: str
     version_added: '0.2.0'
     default: ''
@@ -107,7 +106,7 @@ options:
       - Whether GitLab will do SSL verification when triggering the hook.
     type: bool
     default: false
-    aliases: [ enable_ssl_verification ]
+    aliases: [enable_ssl_verification]
   token:
     description:
       - Secret token to validate hook messages at the receiver.
@@ -115,9 +114,9 @@ options:
       - Will show up in the X-GitLab-Token HTTP request header.
     required: false
     type: str
-'''
+"""
 
-EXAMPLES = '''
+EXAMPLES = r"""
 - name: "Adding a project hook"
   community.general.gitlab_hook:
     api_url: https://gitlab.example.com/
@@ -144,31 +143,31 @@ EXAMPLES = '''
     project: 10
     hook_url: "https://my-ci-server.example.com/gitlab-hook"
     state: absent
-'''
+"""
 
-RETURN = '''
+RETURN = r"""
 msg:
-  description: Success or failure message
+  description: Success or failure message.
   returned: always
   type: str
   sample: "Success"
 
 result:
-  description: json parsed response from the server
+  description: Json parsed response from the server.
   returned: always
   type: dict
 
 error:
-  description: the error message returned by the GitLab API
+  description: The error message returned by the GitLab API.
   returned: failed
   type: str
   sample: "400: path is already in use"
 
 hook:
-  description: API object
+  description: API object.
   returned: always
   type: dict
-'''
+"""
 
 from ansible.module_utils.api import basic_auth_argument_spec
 from ansible.module_utils.basic import AnsibleModule

plugins/modules/gitlab_instance_variable.py

@@ -10,7 +10,7 @@
 from __future__ import absolute_import, division, print_function
 __metaclass__ = type
 
-DOCUMENTATION = r'''
+DOCUMENTATION = r"""
 module: gitlab_instance_variable
 short_description: Creates, updates, or deletes GitLab instance variables
 version_added: 7.1.0
@@ -18,8 +18,8 @@ description:
   - Creates a instance variable if it does not exist.
   - When a instance variable does exist, its value will be updated if the values are different.
   - Support for instance variables requires GitLab >= 13.0.
-  - Variables which are not mentioned in the modules options, but are present on the GitLab instance,
-    will either stay (O(purge=false)) or will be deleted (O(purge=true)).
+  - Variables which are not mentioned in the modules options, but are present on the GitLab instance, will either stay (O(purge=false))
+    or will be deleted (O(purge=true)).
 author:
   - Benedikt Braunger (@benibr)
 requirements:
@@ -78,12 +78,12 @@ options:
         description:
           - Whether a variable is an environment variable (V(env_var)) or a file (V(file)).
         type: str
-        choices: [ "env_var", "file" ]
+        choices: ["env_var", "file"]
         default: env_var
-'''
+"""
 
 
-EXAMPLES = r'''
+EXAMPLES = r"""
 - name: Set or update some CI/CD variables
   community.general.gitlab_instance_variable:
     api_url: https://gitlab.com
@@ -105,9 +105,9 @@ EXAMPLES = r'''
     state: absent
     variables:
       - name: ACCESS_KEY_ID
-'''
+"""
 
-RETURN = r'''
+RETURN = r"""
 instance_variable:
   description: Four lists of the variablenames which were added, updated, removed or exist.
   returned: always
@@ -133,7 +133,7 @@ instance_variable:
       returned: always
       type: list
       sample: ['ACCESS_KEY_ID', 'SECRET_ACCESS_KEY']
-'''
+"""
 
 from ansible.module_utils.basic import AnsibleModule
 from ansible.module_utils.api import basic_auth_argument_spec

plugins/modules/gitlab_issue.py

@@ -12,7 +12,7 @@
 from __future__ import absolute_import, division, print_function
 __metaclass__ = type
 
-DOCUMENTATION = '''
+DOCUMENTATION = r"""
 module: gitlab_issue
 short_description: Create, update, or delete GitLab issues
 version_added: '8.1.0'
@@ -97,10 +97,10 @@ options:
       - A title for the issue. The title is used as a unique identifier to ensure idempotency.
     type: str
     required: true
-'''
+"""
 
 
-EXAMPLES = '''
+EXAMPLES = r"""
 - name: Create Issue
   community.general.gitlab_issue:
     api_url: https://gitlab.com
@@ -109,10 +109,10 @@ EXAMPLES = '''
     title: "Ansible demo Issue"
     description: "Demo Issue description"
     labels:
-        - Ansible
-        - Demo
+      - Ansible
+      - Demo
     assignee_ids:
-        - testassignee
+      - testassignee
     state_filter: "opened"
     state: present
 
@@ -124,9 +124,9 @@ EXAMPLES = '''
     title: "Ansible demo Issue"
     state_filter: "opened"
     state: absent
-'''
+"""
 
-RETURN = r'''
+RETURN = r"""
 msg:
   description: Success or failure message.
   returned: always
@@ -137,7 +137,7 @@ issue:
   description: API object.
   returned: success
   type: dict
-'''
+"""
 
 from ansible.module_utils.basic import AnsibleModule
 from ansible.module_utils.api import basic_auth_argument_spec

plugins/modules/gitlab_label.py

@@ -7,9 +7,9 @@
 from __future__ import absolute_import, division, print_function
 __metaclass__ = type
 
-DOCUMENTATION = '''
+DOCUMENTATION = r"""
 module: gitlab_label
-short_description: Creates/updates/deletes GitLab Labels belonging to project or group.
+short_description: Creates/updates/deletes GitLab Labels belonging to project or group
 version_added: 8.3.0
 description:
   - When a label does not exist, it will be created.
@@ -45,12 +45,12 @@ options:
     required: false
   project:
     description:
-      - The path and name of the project.  Either this or O(group) is required.
+      - The path and name of the project. Either this or O(group) is required.
     required: false
     type: str
   group:
     description:
-      - The path of the group.  Either this or O(project) is required.
+      - The path of the group. Either this or O(project) is required.
     required: false
     type: str
   labels:
@@ -76,21 +76,21 @@ options:
           - Integer value to give priority to the label.
         type: int
         required: false
-        default: null
+        default:
       description:
         description:
           - Label's description.
         type: str
-        default: null
+        default:
       new_name:
         description:
           - Optional field to change label's name.
         type: str
-        default: null
-'''
+        default:
+"""
 
 
-EXAMPLES = '''
+EXAMPLES = r"""
 # same project's task can be executed for group
 - name: Create one Label
   community.general.gitlab_label:
@@ -185,9 +185,9 @@ EXAMPLES = '''
     labels:
       - name: label-abc123
       - name: label-two
-'''
+"""
 
-RETURN = '''
+RETURN = r"""
 labels:
   description: Four lists of the labels which were added, updated, removed or exist.
   returned: success
@@ -217,7 +217,7 @@ labels_obj:
   description: API object.
   returned: success
   type: dict
-'''
+"""
 
 from ansible.module_utils.basic import AnsibleModule
 from ansible.module_utils.api import basic_auth_argument_spec

plugins/modules/gitlab_merge_request.py

@@ -12,7 +12,7 @@
 from __future__ import absolute_import, division, print_function
 __metaclass__ = type
 
-DOCUMENTATION = '''
+DOCUMENTATION = r"""
 module: gitlab_merge_request
 short_description: Create, update, or delete GitLab merge requests
 version_added: 7.1.0
@@ -21,8 +21,7 @@ description:
   - When a single merge request does exist, it will be updated if the provided parameters are different.
   - When a single merge request does exist and O(state=absent), the merge request will be deleted.
   - When multiple merge requests are detected, the task fails.
-  - Existing merge requests are matched based on O(title), O(source_branch), O(target_branch),
-    and O(state_filter) filters.
+  - Existing merge requests are matched based on O(title), O(source_branch), O(target_branch), and O(state_filter) filters.
 author:
   - zvaraondrej (@zvaraondrej)
 requirements:
@@ -102,10 +101,10 @@ options:
       - Comma separated list of reviewers usernames omitting V(@) character.
       - Set to empty string to unassign all reviewers.
     type: str
-'''
+"""
 
 
-EXAMPLES = '''
+EXAMPLES = r"""
 - name: Create Merge Request from branch1 to branch2
   community.general.gitlab_merge_request:
     api_url: https://gitlab.com
@@ -117,7 +116,7 @@ EXAMPLES = '''
     description: "Demo MR description"
     labels: "Ansible,Demo"
     state_filter: "opened"
-    remove_source_branch: True
+    remove_source_branch: true
     state: present
 
 - name: Delete Merge Request from branch1 to branch2
@@ -130,9 +129,9 @@ EXAMPLES = '''
     title: "Ansible demo MR"
     state_filter: "opened"
     state: absent
-'''
+"""
 
-RETURN = r'''
+RETURN = r"""
 msg:
   description: Success or failure message.
   returned: always
@@ -143,7 +142,7 @@ mr:
   description: API object.
   returned: success
   type: dict
-'''
+"""
 
 from ansible.module_utils.basic import AnsibleModule
 from ansible.module_utils.api import basic_auth_argument_spec

plugins/modules/gitlab_milestone.py

@@ -7,7 +7,7 @@
 from __future__ import absolute_import, division, print_function
 __metaclass__ = type
 
-DOCUMENTATION = '''
+DOCUMENTATION = r"""
 module: gitlab_milestone
 short_description: Creates/updates/deletes GitLab Milestones belonging to project or group
 version_added: 8.3.0
@@ -83,10 +83,10 @@ options:
           - Milestone's description.
         type: str
         default: null
-'''
+"""
 
 
-EXAMPLES = '''
+EXAMPLES = r"""
 # same project's task can be executed for group
 - name: Create one milestone
   community.general.gitlab_milestone:
@@ -169,9 +169,9 @@ EXAMPLES = '''
     milestones:
       - title: milestone-abc123
       - title: milestone-two
-'''
+"""
 
-RETURN = '''
+RETURN = r"""
 milestones:
   description: Four lists of the milestones which were added, updated, removed or exist.
   returned: success
@@ -201,7 +201,7 @@ milestones_obj:
   description: API object.
   returned: success
   type: dict
-'''
+"""
 
 from ansible.module_utils.basic import AnsibleModule
 from ansible.module_utils.api import basic_auth_argument_spec

plugins/modules/gitlab_project.py

@@ -9,8 +9,7 @@
 from __future__ import absolute_import, division, print_function
 __metaclass__ = type
 
-DOCUMENTATION = r'''
----
+DOCUMENTATION = r"""
 module: gitlab_project
 short_description: Creates/updates/deletes GitLab Projects
 description:
@@ -179,8 +178,7 @@ options:
     default: true
   lfs_enabled:
     description:
-      - Enable Git large file systems to manages large files such
-        as audio, video, and graphics files.
+      - Enable Git large file systems to manages large files such as audio, video, and graphics files.
     type: bool
     required: false
     default: false
@@ -331,9 +329,9 @@ options:
       - If an wiki for this project should be available or not.
     type: bool
     default: true
-'''
+"""
 
-EXAMPLES = r'''
+EXAMPLES = r"""
 - name: Create GitLab Project
   community.general.gitlab_project:
     api_url: https://gitlab.example.com/
@@ -378,9 +376,9 @@ EXAMPLES = r'''
     api_password: "{{ initial_root_password }}"
     name: my_second_project
     group: "10481470"
-'''
+"""
 
-RETURN = r'''
+RETURN = r"""
 msg:
   description: Success or failure message.
   returned: always
@@ -388,12 +386,12 @@ msg:
   sample: "Success"
 
 result:
-  description: json parsed response from the server.
+  description: JSON-parsed response from the server.
   returned: always
   type: dict
 
 error:
-  description: the error message returned by the GitLab API.
+  description: The error message returned by the GitLab API.
   returned: failed
   type: str
   sample: "400: path is already in use"
@@ -402,7 +400,7 @@ project:
   description: API object.
   returned: always
   type: dict
-'''
+"""
 
 
 from ansible.module_utils.api import basic_auth_argument_spec