[a-n]*.py: normalize doc_fragments (#9422)

* [a-n]*.py: normalize doc_fragments

* Update plugins/doc_fragments/ldap.py

Co-authored-by: Felix Fontein <felix@fontein.de>

* Update plugins/doc_fragments/ldap.py

Co-authored-by: Felix Fontein <felix@fontein.de>

---------

Co-authored-by: Felix Fontein <felix@fontein.de>

plugins/doc_fragments/alicloud.py

@@ -11,75 +11,73 @@ __metaclass__ = type
 class ModuleDocFragment(object):
 
     # Alicloud only documentation fragment
-    DOCUMENTATION = r'''
+    DOCUMENTATION = r"""
 options:
   alicloud_access_key:
     description:
-      - Alibaba Cloud access key. If not set then the value of environment variable E(ALICLOUD_ACCESS_KEY),
+      - Alibaba Cloud access key. If not set then the value of environment variable E(ALICLOUD_ACCESS_KEY), E(ALICLOUD_ACCESS_KEY_ID)
-        E(ALICLOUD_ACCESS_KEY_ID) will be used instead.
+        will be used instead.
     aliases: ['access_key_id', 'access_key']
     type: str
   alicloud_secret_key:
     description:
-      - Alibaba Cloud secret key. If not set then the value of environment variable E(ALICLOUD_SECRET_KEY),
+      - Alibaba Cloud secret key. If not set then the value of environment variable E(ALICLOUD_SECRET_KEY), E(ALICLOUD_SECRET_ACCESS_KEY)
-        E(ALICLOUD_SECRET_ACCESS_KEY) will be used instead.
+        will be used instead.
     aliases: ['secret_access_key', 'secret_key']
     type: str
   alicloud_region:
     description:
-      - The Alibaba Cloud region to use. If not specified then the value of environment variable
+      - The Alibaba Cloud region to use. If not specified then the value of environment variable E(ALICLOUD_REGION), E(ALICLOUD_REGION_ID)
-        E(ALICLOUD_REGION), E(ALICLOUD_REGION_ID) will be used instead.
+        will be used instead.
     aliases: ['region', 'region_id']
     required: true
     type: str
   alicloud_security_token:
     description:
-      - The Alibaba Cloud security token. If not specified then the value of environment variable
+      - The Alibaba Cloud security token. If not specified then the value of environment variable E(ALICLOUD_SECURITY_TOKEN)
-        E(ALICLOUD_SECURITY_TOKEN) will be used instead.
+        will be used instead.
     aliases: ['security_token']
     type: str
   alicloud_assume_role:
     description:
       - If provided with a role ARN, Ansible will attempt to assume this role using the supplied credentials.
-      - The nested assume_role block supports C(alicloud_assume_role_arn), C(alicloud_assume_role_session_name),
+      - The nested assume_role block supports C(alicloud_assume_role_arn), C(alicloud_assume_role_session_name), C(alicloud_assume_role_session_expiration)
-        C(alicloud_assume_role_session_expiration) and C(alicloud_assume_role_policy).
+        and C(alicloud_assume_role_policy).
     type: dict
     aliases: ['assume_role']
   alicloud_assume_role_arn:
     description:
-      - The Alibaba Cloud C(role_arn). The ARN of the role to assume. If ARN is set to an empty string,
+      - The Alibaba Cloud C(role_arn). The ARN of the role to assume. If ARN is set to an empty string, it does not perform
-        it does not perform role switching. It supports environment variable E(ALICLOUD_ASSUME_ROLE_ARN).
+        role switching. It supports environment variable E(ALICLOUD_ASSUME_ROLE_ARN). ansible will execute with provided credentials.
-        ansible will execute with provided credentials.
     aliases: ['assume_role_arn']
     type: str
   alicloud_assume_role_session_name:
     description:
-      - The Alibaba Cloud session_name. The session name to use when assuming the role. If omitted,
+      - The Alibaba Cloud session_name. The session name to use when assuming the role. If omitted, 'ansible' is passed to
-        'ansible' is passed to the AssumeRole call as session name. It supports environment variable
+        the AssumeRole call as session name. It supports environment variable E(ALICLOUD_ASSUME_ROLE_SESSION_NAME).
-        E(ALICLOUD_ASSUME_ROLE_SESSION_NAME).
     aliases: ['assume_role_session_name']
     type: str
   alicloud_assume_role_session_expiration:
     description:
-      - The Alibaba Cloud C(session_expiration). The time after which the established session for assuming
+      - The Alibaba Cloud C(session_expiration). The time after which the established session for assuming role expires. Valid
-        role expires. Valid value range 900-3600 seconds. Default to 3600 (in this case Alicloud use own default
+        value range 900-3600 seconds. Default to 3600 (in this case Alicloud use own default value). It supports environment
-        value). It supports environment variable E(ALICLOUD_ASSUME_ROLE_SESSION_EXPIRATION).
+        variable E(ALICLOUD_ASSUME_ROLE_SESSION_EXPIRATION).
     aliases: ['assume_role_session_expiration']
     type: int
   ecs_role_name:
     description:
-      - The RAM Role Name attached on a ECS instance for API operations. You can retrieve this from the 'Access Control'
+      - The RAM Role Name attached on a ECS instance for API operations. You can retrieve this from the 'Access Control' section
-        section of the Alibaba Cloud console.
+        of the Alibaba Cloud console.
-      - If you're running Ansible from an ECS instance with RAM Instance using RAM Role, Ansible will just access the
+      - If you are running Ansible from an ECS instance with RAM Instance using RAM Role, Ansible will just access the metadata
-        metadata U(http://100.100.100.200/latest/meta-data/ram/security-credentials/<ecs_role_name>) to obtain the STS
+        U(http://100.100.100.200/latest/meta-data/ram/security-credentials/<ecs_role_name>) to obtain the STS credential.
-        credential. This is a preferred approach over any other when running in ECS as you can avoid hard coding
+        This is a preferred approach over any other when running in ECS as you can avoid hard coding credentials. Instead
-        credentials. Instead these are leased on-the-fly by Ansible which reduces the chance of leakage.
+        these are leased on-the-fly by Ansible which reduces the chance of leakage.
     aliases: ['role_name']
     type: str
   profile:
     description:
-      - This is the Alicloud profile name as set in the shared credentials file. It can also be sourced from the
+      - This is the Alicloud profile name as set in the shared credentials file. It can also be sourced from the E(ALICLOUD_PROFILE)
-        E(ALICLOUD_PROFILE) environment variable.
+        environment variable.
     type: str
   shared_credentials_file:
     description:
@@ -88,22 +86,14 @@ options:
       - If this is not set and a profile is specified, C(~/.aliyun/config.json) will be used.
     type: str
 author:
-    - "He Guimin (@xiaozhu36)"
+  - "He Guimin (@xiaozhu36)"
 requirements:
-    - "Python >= 3.6"
+  - "Python >= 3.6"
 notes:
-  - If parameters are not set within the module, the following
+  - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence
-    environment variables can be used in decreasing order of precedence
+    E(ALICLOUD_ACCESS_KEY) or E(ALICLOUD_ACCESS_KEY_ID), E(ALICLOUD_SECRET_KEY) or E(ALICLOUD_SECRET_ACCESS_KEY), E(ALICLOUD_REGION)
-    E(ALICLOUD_ACCESS_KEY) or E(ALICLOUD_ACCESS_KEY_ID),
+    or E(ALICLOUD_REGION_ID), E(ALICLOUD_SECURITY_TOKEN), E(ALICLOUD_ECS_ROLE_NAME), E(ALICLOUD_SHARED_CREDENTIALS_FILE),
-    E(ALICLOUD_SECRET_KEY) or E(ALICLOUD_SECRET_ACCESS_KEY),
+    E(ALICLOUD_PROFILE), E(ALICLOUD_ASSUME_ROLE_ARN), E(ALICLOUD_ASSUME_ROLE_SESSION_NAME), E(ALICLOUD_ASSUME_ROLE_SESSION_EXPIRATION).
-    E(ALICLOUD_REGION) or E(ALICLOUD_REGION_ID),
+  - E(ALICLOUD_REGION) or E(ALICLOUD_REGION_ID) can be typically be used to specify the Alicloud region, when required, but
-    E(ALICLOUD_SECURITY_TOKEN),
+    this can also be configured in the footmark config file.
-    E(ALICLOUD_ECS_ROLE_NAME),
+"""
-    E(ALICLOUD_SHARED_CREDENTIALS_FILE),
-    E(ALICLOUD_PROFILE),
-    E(ALICLOUD_ASSUME_ROLE_ARN),
-    E(ALICLOUD_ASSUME_ROLE_SESSION_NAME),
-    E(ALICLOUD_ASSUME_ROLE_SESSION_EXPIRATION).
-  - E(ALICLOUD_REGION) or E(ALICLOUD_REGION_ID) can be typically be used to specify the
-    Alicloud region, when required, but this can also be configured in the footmark config file
-'''

plugins/doc_fragments/attributes.py

@@ -11,22 +11,22 @@ __metaclass__ = type
 class ModuleDocFragment(object):
 
     # Standard documentation fragment
-    DOCUMENTATION = r'''
+    DOCUMENTATION = r"""
 options: {}
 attributes:
-    check_mode:
+  check_mode:
-      description: Can run in C(check_mode) and return changed status prediction without modifying target.
+    description: Can run in C(check_mode) and return changed status prediction without modifying target.
-    diff_mode:
+  diff_mode:
-      description: Will return details on what has changed (or possibly needs changing in C(check_mode)), when in diff mode.
+    description: Will return details on what has changed (or possibly needs changing in C(check_mode)), when in diff mode.
-'''
+"""
 
-    PLATFORM = r'''
+    PLATFORM = r"""
 options: {}
 attributes:
-    platform:
+  platform:
-      description: Target OS/families that can be operated against.
+    description: Target OS/families that can be operated against.
-      support: N/A
+    support: N/A
-'''
+"""
 
     # Should be used together with the standard fragment
     INFO_MODULE = r'''
@@ -42,23 +42,23 @@ attributes:
         - This action does not modify state.
 '''
 
-    CONN = r'''
+    CONN = r"""
 options: {}
 attributes:
-    become:
+  become:
-      description: Is usable alongside C(become) keywords.
+    description: Is usable alongside C(become) keywords.
-    connection:
+  connection:
-      description: Uses the target's configured connection information to execute code on it.
+    description: Uses the target's configured connection information to execute code on it.
-    delegation:
+  delegation:
-      description: Can be used in conjunction with C(delegate_to) and related keywords.
+    description: Can be used in conjunction with C(delegate_to) and related keywords.
-'''
+"""
 
-    FACTS = r'''
+    FACTS = r"""
 options: {}
 attributes:
-    facts:
+  facts:
-      description: Action returns an C(ansible_facts) dictionary that will update existing host facts.
+    description: Action returns an C(ansible_facts) dictionary that will update existing host facts.
-'''
+"""
 
     # Should be used together with the standard fragment and the FACTS fragment
     FACTS_MODULE = r'''
@@ -76,18 +76,18 @@ attributes:
       support: full
 '''
 
-    FILES = r'''
+    FILES = r"""
 options: {}
 attributes:
-    safe_file_operations:
+  safe_file_operations:
-      description: Uses Ansible's strict file operation functions to ensure proper permissions and avoid data corruption.
+    description: Uses Ansible's strict file operation functions to ensure proper permissions and avoid data corruption.
-'''
+"""
 
-    FLOW = r'''
+    FLOW = r"""
 options: {}
 attributes:
-    action:
+  action:
-      description: Indicates this has a corresponding action plugin so some parts of the options can be executed on the controller.
+    description: Indicates this has a corresponding action plugin so some parts of the options can be executed on the controller.
-    async:
+  async:
-      description: Supports being used with the C(async) keyword.
+    description: Supports being used with the C(async) keyword.
-'''
+"""

plugins/doc_fragments/auth_basic.py

@@ -10,7 +10,7 @@ __metaclass__ = type
 class ModuleDocFragment(object):
 
     # Standard files documentation fragment
-    DOCUMENTATION = r'''
+    DOCUMENTATION = r"""
 options:
   api_url:
     description:
@@ -29,4 +29,4 @@ options:
       - Whether or not to validate SSL certs when supplying a HTTPS endpoint.
     type: bool
     default: true
-'''
+"""

plugins/doc_fragments/bitbucket.py

@@ -11,7 +11,7 @@ __metaclass__ = type
 class ModuleDocFragment(object):
 
     # Standard documentation fragment
-    DOCUMENTATION = r'''
+    DOCUMENTATION = r"""
 options:
   client_id:
     description:
@@ -30,7 +30,7 @@ options:
       - O(ignore:username) is an alias of O(user) since community.general 6.0.0. It was an alias of O(workspace) before.
     type: str
     version_added: 4.0.0
-    aliases: [ username ]
+    aliases: [username]
   password:
     description:
       - The App password.
@@ -41,4 +41,4 @@ notes:
   - Bitbucket OAuth consumer key and secret can be obtained from Bitbucket profile -> Settings -> Access Management -> OAuth.
   - Bitbucket App password can be created from Bitbucket profile -> Personal Settings -> App passwords.
   - If both OAuth and Basic Auth credentials are passed, OAuth credentials take precedence.
-'''
+"""

plugins/doc_fragments/consul.py

@@ -15,7 +15,7 @@ class ModuleDocFragment:
 options:
   host:
     description:
-      - Host of the consul agent, defaults to V(localhost).
+      - Host of the Consul agent.
     default: localhost
     type: str
   port:
@@ -25,18 +25,18 @@ options:
     default: 8500
   scheme:
     description:
-      - The protocol scheme on which the consul agent is running.
+      - The protocol scheme on which the Consul agent is running. Defaults to V(http) and can be set to V(https) for secure
-        Defaults to V(http) and can be set to V(https) for secure connections.
+        connections.
     default: http
     type: str
   validate_certs:
     type: bool
     description:
-      - Whether to verify the TLS certificate of the consul agent.
+      - Whether to verify the TLS certificate of the Consul agent.
     default: true
   ca_path:
     description:
-      - The CA bundle to use for https connections
+      - The CA bundle to use for https connections.
     type: str
 """
 

plugins/doc_fragments/dimensiondata.py

@@ -14,8 +14,7 @@ __metaclass__ = type
 class ModuleDocFragment(object):
 
     # Dimension Data doc fragment
-    DOCUMENTATION = r'''
+    DOCUMENTATION = r"""
-
 options:
   region:
     description:
@@ -48,4 +47,4 @@ options:
       - This should only be used on private instances of the CloudControl API that use self-signed certificates.
     type: bool
     default: true
-'''
+"""

plugins/doc_fragments/dimensiondata_wait.py

@@ -14,8 +14,7 @@ __metaclass__ = type
 class ModuleDocFragment(object):
 
     # Dimension Data ("wait-for-completion" parameters) doc fragment
-    DOCUMENTATION = r'''
+    DOCUMENTATION = r"""
-
 options:
   wait:
     description:
@@ -34,4 +33,4 @@ options:
       - Only applicable if O(wait=true).
     type: int
     default: 2
-'''
+"""

plugins/doc_fragments/django.py

@@ -8,7 +8,7 @@ __metaclass__ = type
 
 
 class ModuleDocFragment(object):
-    DOCUMENTATION = r'''
+    DOCUMENTATION = r"""
 options:
   venv:
     description:
@@ -43,20 +43,19 @@ options:
 
 notes:
   - The C(django-admin) command is always executed using the C(C) locale, and the option C(--no-color) is always passed.
-
 seealso:
   - name: django-admin and manage.py in official Django documentation
     description: >-
-      Refer to this documentation for the builtin commands and options of C(django-admin).
+      Refer to this documentation for the builtin commands and options of C(django-admin). Please make sure that you select
-      Please make sure that you select the right version of Django in the version selector on that page.
+      the right version of Django in the version selector on that page.
     link: https://docs.djangoproject.com/en/5.0/ref/django-admin/
-'''
+"""
 
-    DATABASE = r'''
+    DATABASE = r"""
 options:
   database:
     description:
       - Specify the database to be used.
     type: str
     default: default
-'''
+"""

plugins/doc_fragments/emc.py

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

plugins/doc_fragments/gitlab.py

@@ -10,7 +10,7 @@ __metaclass__ = type
 class ModuleDocFragment(object):
 
     # Standard files documentation fragment
-    DOCUMENTATION = r'''
+    DOCUMENTATION = r"""
 requirements:
   - requests (Python library U(https://pypi.org/project/requests/))
 
@@ -34,4 +34,4 @@ options:
       - The CA certificates bundle to use to verify GitLab server certificate.
     type: str
     version_added: 8.1.0
-'''
+"""

plugins/doc_fragments/hpe3par.py

@@ -10,26 +10,26 @@ __metaclass__ = type
 class ModuleDocFragment(object):
 
     # HPE 3PAR doc fragment
-    DOCUMENTATION = '''
+    DOCUMENTATION = r"""
 options:
-    storage_system_ip:
+  storage_system_ip:
-      description:
+    description:
-        - The storage system IP address.
+      - The storage system IP address.
-      type: str
+    type: str
-      required: true
+    required: true
-    storage_system_password:
+  storage_system_password:
-      description:
+    description:
-        - The storage system password.
+      - The storage system password.
-      type: str
+    type: str
-      required: true
+    required: true
-    storage_system_username:
+  storage_system_username:
-      description:
+    description:
-        - The storage system user name.
+      - The storage system user name.
-      type: str
+    type: str
-      required: true
+    required: true
 
 requirements:
   - hpe3par_sdk >= 1.0.2. Install using C(pip install hpe3par_sdk).
   - WSAPI service should be enabled on the 3PAR storage array.
 notes:
-    '''
+"""

plugins/doc_fragments/hwc.py

@@ -10,56 +10,50 @@ __metaclass__ = type
 class ModuleDocFragment(object):
 
     # HWC doc fragment.
-    DOCUMENTATION = '''
+    DOCUMENTATION = r"""
 options:
-    identity_endpoint:
+  identity_endpoint:
-        description:
+    description:
-            - The Identity authentication URL.
+      - The Identity authentication URL.
-        type: str
+    type: str
-        required: true
+    required: true
-    user:
+  user:
-        description:
+    description:
-            - The user name to login with.
+      - The user name to login with.
-            - Currently only user names are supported, and not user IDs.
+      - Currently only user names are supported, and not user IDs.
-        type: str
+    type: str
-        required: true
+    required: true
-    password:
+  password:
-        description:
+    description:
-            - The password to login with.
+      - The password to login with.
-        type: str
+    type: str
-        required: true
+    required: true
-    domain:
+  domain:
-        description:
+    description:
-            - The name of the Domain to scope to (Identity v3).
+      - The name of the Domain to scope to (Identity v3).
-            - Currently only domain names are supported, and not domain IDs.
+      - Currently only domain names are supported, and not domain IDs.
-        type: str
+    type: str
-        required: true
+    required: true
-    project:
+  project:
-        description:
+    description:
-            - The name of the Tenant (Identity v2) or Project (Identity v3).
+      - The name of the Tenant (Identity v2) or Project (Identity v3).
-            - Currently only project names are supported, and not project IDs.
+      - Currently only project names are supported, and not project IDs.
-        type: str
+    type: str
-        required: true
+    required: true
-    region:
+  region:
-        description:
+    description:
-            - The region to which the project belongs.
+      - The region to which the project belongs.
-        type: str
+    type: str
-    id:
+  id:
-        description:
+    description:
-            - The ID of resource to be managed.
+      - The ID of resource to be managed.
-        type: str
+    type: str
 notes:
-  - For authentication, you can set identity_endpoint using the
+  - For authentication, you can set identity_endpoint using the E(ANSIBLE_HWC_IDENTITY_ENDPOINT) environment variable.
-    E(ANSIBLE_HWC_IDENTITY_ENDPOINT) environment variable.
+  - For authentication, you can set user using the E(ANSIBLE_HWC_USER) environment variable.
-  - For authentication, you can set user using the
+  - For authentication, you can set password using the E(ANSIBLE_HWC_PASSWORD) environment variable.
-    E(ANSIBLE_HWC_USER) environment variable.
+  - For authentication, you can set domain using the E(ANSIBLE_HWC_DOMAIN) environment variable.
-  - For authentication, you can set password using the E(ANSIBLE_HWC_PASSWORD) environment
+  - For authentication, you can set project using the E(ANSIBLE_HWC_PROJECT) environment variable.
-    variable.
-  - For authentication, you can set domain using the E(ANSIBLE_HWC_DOMAIN) environment
-    variable.
-  - For authentication, you can set project using the E(ANSIBLE_HWC_PROJECT) environment
-    variable.
   - For authentication, you can set region using the E(ANSIBLE_HWC_REGION) environment variable.
-  - Environment variables values will only be used if the playbook values are
+  - Environment variables values will only be used if the playbook values are not set.
-    not set.
+"""
-'''

plugins/doc_fragments/ibm_storage.py

@@ -12,26 +12,25 @@ __metaclass__ = type
 class ModuleDocFragment(object):
 
     # ibm_storage documentation fragment
-    DOCUMENTATION = r'''
+    DOCUMENTATION = r"""
 options:
-    username:
+  username:
-        description:
+    description:
-            - Management user on the spectrum accelerate storage system.
+      - Management user on the Spectrum Accelerate storage system.
-        type: str
+    type: str
-        required: true
+    required: true
-    password:
+  password:
-        description:
+    description:
-            - Password for username on the spectrum accelerate storage system.
+      - Password for username on the Spectrum Accelerate storage system.
-        type: str
+    type: str
-        required: true
+    required: true
-    endpoints:
+  endpoints:
-        description:
+    description:
-            - The hostname or management IP of Spectrum Accelerate storage system.
+      - The hostname or management IP of Spectrum Accelerate storage system.
-        type: str
+    type: str
-        required: true
+    required: true
 notes:
-  - This module requires pyxcli python library.
+  - This module requires pyxcli python library. Use C(pip install pyxcli) in order to get pyxcli.
-    Use C(pip install pyxcli) in order to get pyxcli.
 requirements:
   - pyxcli
-'''
+"""

plugins/doc_fragments/influxdb.py

@@ -11,72 +11,72 @@ __metaclass__ = type
 
 class ModuleDocFragment(object):
     # Parameters for influxdb modules
-    DOCUMENTATION = r'''
+    DOCUMENTATION = r"""
 options:
   hostname:
     description:
-    - The hostname or IP address on which InfluxDB server is listening.
+      - The hostname or IP address on which InfluxDB server is listening.
     type: str
     default: localhost
   username:
     description:
-    - Username that will be used to authenticate against InfluxDB server.
+      - Username that will be used to authenticate against InfluxDB server.
     type: str
     default: root
-    aliases: [ login_username ]
+    aliases: [login_username]
   password:
     description:
-    - Password that will be used to authenticate against InfluxDB server.
+      - Password that will be used to authenticate against InfluxDB server.
     type: str
     default: root
-    aliases: [ login_password ]
+    aliases: [login_password]
   port:
     description:
-    - The port on which InfluxDB server is listening.
+      - The port on which InfluxDB server is listening.
     type: int
     default: 8086
   path:
     description:
-    - The path on which InfluxDB server is accessible.
+      - The path on which InfluxDB server is accessible.
-    - Only available when using python-influxdb >= 5.1.0.
+      - Only available when using python-influxdb >= 5.1.0.
     type: str
     default: ''
     version_added: '0.2.0'
   validate_certs:
     description:
-    - If set to V(false), the SSL certificates will not be validated.
+      - If set to V(false), the SSL certificates will not be validated.
-    - This should only set to V(false) used on personally controlled sites using self-signed certificates.
+      - This should only set to V(false) used on personally controlled sites using self-signed certificates.
     type: bool
     default: true
   ssl:
     description:
-    - Use https instead of http to connect to InfluxDB server.
+      - Use https instead of http to connect to InfluxDB server.
     type: bool
     default: false
   timeout:
     description:
-    - Number of seconds Requests will wait for client to establish a connection.
+      - Number of seconds Requests will wait for client to establish a connection.
     type: int
   retries:
     description:
-    - Number of retries client will try before aborting.
+      - Number of retries client will try before aborting.
-    - V(0) indicates try until success.
+      - V(0) indicates try until success.
-    - Only available when using python-influxdb >= 4.1.0.
+      - Only available when using C(python-influxdb) >= 4.1.0.
     type: int
     default: 3
   use_udp:
     description:
-    - Use UDP to connect to InfluxDB server.
+      - Use UDP to connect to InfluxDB server.
     type: bool
     default: false
   udp_port:
     description:
-    - UDP port to connect to InfluxDB server.
+      - UDP port to connect to InfluxDB server.
     type: int
     default: 4444
   proxies:
     description:
-    - HTTP(S) proxy to use for Requests to connect to InfluxDB server.
+      - HTTP(S) proxy to use for Requests to connect to InfluxDB server.
     type: dict
     default: {}
-'''
+"""

plugins/doc_fragments/ipa.py

@@ -11,61 +11,66 @@ __metaclass__ = type
 
 class ModuleDocFragment(object):
     # Parameters for FreeIPA/IPA modules
-    DOCUMENTATION = r'''
+    DOCUMENTATION = r"""
 options:
   ipa_port:
     description:
-    - Port of FreeIPA / IPA server.
+      - Port of FreeIPA / IPA server.
-    - If the value is not specified in the task, the value of environment variable E(IPA_PORT) will be used instead.
+      - If the value is not specified in the task, the value of environment variable E(IPA_PORT) will be used instead.
-    - If both the environment variable E(IPA_PORT) and the value are not specified in the task, then default value is set.
+      - If both the environment variable E(IPA_PORT) and the value are not specified in the task, then default value is set.
     type: int
     default: 443
   ipa_host:
     description:
-    - IP or hostname of IPA server.
+      - IP or hostname of IPA server.
-    - If the value is not specified in the task, the value of environment variable E(IPA_HOST) will be used instead.
+      - If the value is not specified in the task, the value of environment variable E(IPA_HOST) will be used instead.
-    - If both the environment variable E(IPA_HOST) and the value are not specified in the task, then DNS will be used to try to discover the FreeIPA server.
+      - If both the environment variable E(IPA_HOST) and the value are not specified in the task, then DNS will be used to
-    - The relevant entry needed in FreeIPA is the C(ipa-ca) entry.
+        try to discover the FreeIPA server.
-    - If neither the DNS entry, nor the environment E(IPA_HOST), nor the value are available in the task, then the default value will be used.
+      - The relevant entry needed in FreeIPA is the C(ipa-ca) entry.
+      - If neither the DNS entry, nor the environment E(IPA_HOST), nor the value are available in the task, then the default
+        value will be used.
     type: str
     default: ipa.example.com
   ipa_user:
     description:
-    - Administrative account used on IPA server.
+      - Administrative account used on IPA server.
-    - If the value is not specified in the task, the value of environment variable E(IPA_USER) will be used instead.
+      - If the value is not specified in the task, the value of environment variable E(IPA_USER) will be used instead.
-    - If both the environment variable E(IPA_USER) and the value are not specified in the task, then default value is set.
+      - If both the environment variable E(IPA_USER) and the value are not specified in the task, then default value is set.
     type: str
     default: admin
   ipa_pass:
     description:
-    - Password of administrative user.
+      - Password of administrative user.
-    - If the value is not specified in the task, the value of environment variable E(IPA_PASS) will be used instead.
+      - If the value is not specified in the task, the value of environment variable E(IPA_PASS) will be used instead.
-    - Note that if the C(urllib_gssapi) library is available, it is possible to use GSSAPI to authenticate to FreeIPA.
+      - Note that if the C(urllib_gssapi) library is available, it is possible to use GSSAPI to authenticate to FreeIPA.
-    - If the environment variable E(KRB5CCNAME) is available, the module will use this kerberos credentials cache to authenticate to the FreeIPA server.
+      - If the environment variable E(KRB5CCNAME) is available, the module will use this kerberos credentials cache to authenticate
-    - If the environment variable E(KRB5_CLIENT_KTNAME) is available, and E(KRB5CCNAME) is not; the module will use this kerberos keytab to authenticate.
+        to the FreeIPA server.
-    - If GSSAPI is not available, the usage of O(ipa_pass) is required.
+      - If the environment variable E(KRB5_CLIENT_KTNAME) is available, and E(KRB5CCNAME) is not; the module will use this
+        kerberos keytab to authenticate.
+      - If GSSAPI is not available, the usage of O(ipa_pass) is required.
     type: str
   ipa_prot:
     description:
-    - Protocol used by IPA server.
+      - Protocol used by IPA server.
-    - If the value is not specified in the task, the value of environment variable E(IPA_PROT) will be used instead.
+      - If the value is not specified in the task, the value of environment variable E(IPA_PROT) will be used instead.
-    - If both the environment variable E(IPA_PROT) and the value are not specified in the task, then default value is set.
+      - If both the environment variable E(IPA_PROT) and the value are not specified in the task, then default value is set.
     type: str
-    choices: [ http, https ]
+    choices: [http, https]
     default: https
   validate_certs:
     description:
-    - This only applies if O(ipa_prot) is V(https).
+      - This only applies if O(ipa_prot) is V(https).
-    - If set to V(false), the SSL certificates will not be validated.
+      - If set to V(false), the SSL certificates will not be validated.
-    - This should only set to V(false) used on personally controlled sites using self-signed certificates.
+      - This should only set to V(false) used on personally controlled sites using self-signed certificates.
     type: bool
     default: true
   ipa_timeout:
     description:
-    - Specifies idle timeout (in seconds) for the connection.
+      - Specifies idle timeout (in seconds) for the connection.
-    - For bulk operations, you may want to increase this in order to avoid timeout from IPA server.
+      - For bulk operations, you may want to increase this in order to avoid timeout from IPA server.
-    - If the value is not specified in the task, the value of environment variable E(IPA_TIMEOUT) will be used instead.
+      - If the value is not specified in the task, the value of environment variable E(IPA_TIMEOUT) will be used instead.
-    - If both the environment variable E(IPA_TIMEOUT) and the value are not specified in the task, then default value is set.
+      - If both the environment variable E(IPA_TIMEOUT) and the value are not specified in the task, then default value is
+        set.
     type: int
     default: 10
-'''
+"""

plugins/doc_fragments/keycloak.py

@@ -11,72 +11,72 @@ __metaclass__ = type
 class ModuleDocFragment(object):
 
     # Standard documentation fragment
-    DOCUMENTATION = r'''
+    DOCUMENTATION = r"""
 options:
-    auth_keycloak_url:
+  auth_keycloak_url:
-        description:
+    description:
-            - URL to the Keycloak instance.
+      - URL to the Keycloak instance.
-        type: str
+    type: str
-        required: true
+    required: true
-        aliases:
+    aliases:
-          - url
+      - url
 
-    auth_client_id:
+  auth_client_id:
-        description:
+    description:
-            - OpenID Connect C(client_id) to authenticate to the API with.
+      - OpenID Connect C(client_id) to authenticate to the API with.
-        type: str
+    type: str
-        default: admin-cli
+    default: admin-cli
 
-    auth_realm:
+  auth_realm:
-        description:
+    description:
-            - Keycloak realm name to authenticate to for API access.
+      - Keycloak realm name to authenticate to for API access.
-        type: str
+    type: str
 
-    auth_client_secret:
+  auth_client_secret:
-        description:
+    description:
-            - Client Secret to use in conjunction with O(auth_client_id) (if required).
+      - Client Secret to use in conjunction with O(auth_client_id) (if required).
-        type: str
+    type: str
 
-    auth_username:
+  auth_username:
-        description:
+    description:
-            - Username to authenticate for API access with.
+      - Username to authenticate for API access with.
-        type: str
+    type: str
-        aliases:
+    aliases:
-          - username
+      - username
 
-    auth_password:
+  auth_password:
-        description:
+    description:
-            - Password to authenticate for API access with.
+      - Password to authenticate for API access with.
-        type: str
+    type: str
-        aliases:
+    aliases:
-          - password
+      - password
 
-    token:
+  token:
-        description:
+    description:
-            - Authentication token for Keycloak API.
+      - Authentication token for Keycloak API.
-        type: str
+    type: str
-        version_added: 3.0.0
+    version_added: 3.0.0
 
-    validate_certs:
+  validate_certs:
-        description:
+    description:
-            - Verify TLS certificates (do not disable this in production).
+      - Verify TLS certificates (do not disable this in production).
-        type: bool
+    type: bool
-        default: true
+    default: true
 
-    connection_timeout:
+  connection_timeout:
-        description:
+    description:
-            - Controls the HTTP connections timeout period (in seconds) to Keycloak API.
+      - Controls the HTTP connections timeout period (in seconds) to Keycloak API.
-        type: int
+    type: int
-        default: 10
+    default: 10
-        version_added: 4.5.0
+    version_added: 4.5.0
 
-    http_agent:
+  http_agent:
-        description:
+    description:
-            - Configures the HTTP User-Agent header.
+      - Configures the HTTP User-Agent header.
-        type: str
+    type: str
-        default: Ansible
+    default: Ansible
-        version_added: 5.4.0
+    version_added: 5.4.0
-'''
+"""
 
     ACTIONGROUP_KEYCLOAK = r"""
 options: {}

plugins/doc_fragments/ldap.py

@@ -12,12 +12,12 @@ __metaclass__ = type
 
 class ModuleDocFragment(object):
     # Standard LDAP documentation fragment
-    DOCUMENTATION = r'''
+    DOCUMENTATION = r"""
 options:
   bind_dn:
     description:
-      - A DN to bind with. If this is omitted, we'll try a SASL bind with the EXTERNAL mechanism as default.
+      - A DN to bind with. Try to use a SASL bind with the EXTERNAL mechanism as default when this parameter is omitted.
-      - If this is blank, we'll use an anonymous bind.
+      - Use an anonymous bind if the parameter is blank.
     type: str
   bind_pw:
     description:
@@ -57,7 +57,8 @@ options:
     version_added: 2.0.0
   server_uri:
     description:
-      - The O(server_uri) parameter may be a comma- or whitespace-separated list of URIs containing only the schema, the host, and the port fields.
+      - The O(server_uri) parameter may be a comma- or whitespace-separated list of URIs containing only the schema, the host,
+        and the port fields.
       - The default value lets the underlying LDAP client library look for a UNIX domain socket in its default location.
       - Note that when using multiple URIs you cannot determine to which URI your client gets connected.
       - For URIs containing additional fields, particularly when using commas, behavior is undefined.
@@ -65,7 +66,7 @@ options:
     default: ldapi:///
   start_tls:
     description:
-      - If true, we'll use the START_TLS LDAP extension.
+      - Use the START_TLS LDAP extension if set to V(true).
     type: bool
     default: false
   validate_certs:
@@ -91,4 +92,4 @@ options:
     choices: ['enable', 'auto', 'disable']
     default: auto
     version_added: "6.4.0"
-'''
+"""

plugins/doc_fragments/lxca_common.py

@@ -10,7 +10,7 @@ __metaclass__ = type
 
 class ModuleDocFragment(object):
     # Standard Pylxca documentation fragment
-    DOCUMENTATION = r'''
+    DOCUMENTATION = r"""
 author:
   - Naval Patel (@navalkp)
   - Prashant Bhosale (@prabhosa)
@@ -18,19 +18,19 @@ author:
 options:
   login_user:
     description:
-    - The username for use in HTTP basic authentication.
+      - The username for use in HTTP basic authentication.
     type: str
     required: true
 
   login_password:
     description:
-    - The password for use in HTTP basic authentication.
+      - The password for use in HTTP basic authentication.
     type: str
     required: true
 
   auth_url:
     description:
-    - lxca HTTPS full web address.
+      - Lxca HTTPS full web address.
     type: str
     required: true
 
@@ -40,4 +40,4 @@ requirements:
 notes:
   - Additional detail about pylxca can be found at U(https://github.com/lenovo/pylxca).
   - Playbooks using these modules can be found at U(https://github.com/lenovo/ansible.lenovo-lxca).
-'''
+"""

plugins/doc_fragments/manageiq.py

@@ -11,7 +11,7 @@ __metaclass__ = type
 class ModuleDocFragment(object):
 
     # Standard ManageIQ documentation fragment
-    DOCUMENTATION = r'''
+    DOCUMENTATION = r"""
 options:
   manageiq_connection:
     description:
@@ -34,20 +34,21 @@ options:
         type: str
       token:
         description:
-          - ManageIQ token. E(MIQ_TOKEN) environment variable if set. Otherwise, required if no username or password is passed in.
+          - ManageIQ token. E(MIQ_TOKEN) environment variable if set. Otherwise, required if no username or password is passed
+            in.
         type: str
       validate_certs:
         description:
           - Whether SSL certificates should be verified for HTTPS requests.
         type: bool
         default: true
-        aliases: [ verify_ssl ]
+        aliases: [verify_ssl]
       ca_cert:
         description:
           - The path to a CA bundle file or directory with certificates.
         type: str
-        aliases: [ ca_bundle_path ]
+        aliases: [ca_bundle_path]
 
 requirements:
   - 'manageiq-client U(https://github.com/ManageIQ/manageiq-api-client-python/)'
-'''
+"""

plugins/doc_fragments/nomad.py

@@ -11,48 +11,48 @@ __metaclass__ = type
 class ModuleDocFragment(object):
 
     # Standard files documentation fragment
-    DOCUMENTATION = r'''
+    DOCUMENTATION = r"""
 options:
-    host:
+  host:
-      description:
+    description:
-        - FQDN of Nomad server.
+      - FQDN of Nomad server.
-      required: true
+    required: true
-      type: str
+    type: str
-    port:
+  port:
-      description:
+    description:
-        - Port of Nomad server.
+      - Port of Nomad server.
-      type: int
+    type: int
-      default: 4646
+    default: 4646
-      version_added: 8.0.0
+    version_added: 8.0.0
-    use_ssl:
+  use_ssl:
-      description:
+    description:
-        - Use TLS/SSL connection.
+      - Use TLS/SSL connection.
-      type: bool
+    type: bool
-      default: true
+    default: true
-    timeout:
+  timeout:
-      description:
+    description:
-        - Timeout (in seconds) for the request to Nomad.
+      - Timeout (in seconds) for the request to Nomad.
-      type: int
+    type: int
-      default: 5
+    default: 5
-    validate_certs:
+  validate_certs:
-      description:
+    description:
-        - Enable TLS/SSL certificate validation.
+      - Enable TLS/SSL certificate validation.
-      type: bool
+    type: bool
-      default: true
+    default: true
-    client_cert:
+  client_cert:
-      description:
+    description:
-        - Path of certificate for TLS/SSL.
+      - Path of certificate for TLS/SSL.
-      type: path
+    type: path
-    client_key:
+  client_key:
-      description:
+    description:
-        - Path of certificate's private key for TLS/SSL.
+      - Path of certificate's private key for TLS/SSL.
-      type: path
+    type: path
-    namespace:
+  namespace:
-      description:
+    description:
-        - Namespace for Nomad.
+      - Namespace for Nomad.
-      type: str
+    type: str
-    token:
+  token:
-      description:
+    description:
-        - ACL token for authentication.
+      - ACL token for authentication.
-      type: str
+    type: str
-'''
+"""