multiple modules 2: fixed markups in doc (#5237) (#5244)

* multiple modules 2: fixed markups in doc

* Update plugins/modules/cloud/misc/proxmox_template.py

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

Co-authored-by: Felix Fontein <felix@fontein.de>
(cherry picked from commit 999fc475a2)

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

plugins/modules/cloud/misc/proxmox_template.py

@@ -22,45 +22,45 @@ options:
     type: str
   src:
     description:
-      - path to uploaded file
+      - Path to uploaded file.
-      - required only for C(state=present)
+      - Required only for I(state=present).
     type: path
   template:
     description:
-      - the template name
+      - The template name.
-      - Required for state C(absent) to delete a template.
+      - Required for I(state=absent) to delete a template.
-      - Required for state C(present) to download an appliance container template (pveam).
+      - Required for I(state=present) to download an appliance container template (pveam).
     type: str
   content_type:
     description:
-      - content type
+      - Content type.
-      - required only for C(state=present)
+      - Required only for I(state=present).
     type: str
     default: 'vztmpl'
     choices: ['vztmpl', 'iso']
   storage:
     description:
-      - target storage
+      - Target storage.
     type: str
     default: 'local'
   timeout:
     description:
-      - timeout for operations
+      - Timeout for operations.
     type: int
     default: 30
   force:
     description:
-      - can be used only with C(state=present), exists template will be overwritten
+      - It can only be used with I(state=present), existing template will be overwritten.
     type: bool
     default: false
   state:
     description:
-     - Indicate desired state of the template
+     - Indicate desired state of the template.
     type: str
     choices: ['present', 'absent']
     default: present
 notes:
-  - Requires proxmoxer and requests modules on host. This modules can be installed with pip.
+  - Requires C(proxmoxer) and C(requests) modules on host. This modules can be installed with M(ansible.builtin.pip).
 author: Sergei Antipov (@UnderGreen)
 extends_documentation_fragment: community.general.proxmox.documentation
 '''

plugins/modules/cloud/opennebula/one_service.py

@@ -50,30 +50,30 @@ options:
     type: str
   template_name:
     description:
-      - Name of service template to use to create a new instance of a service
+      - Name of service template to use to create a new instance of a service.
     type: str
   template_id:
     description:
-      - ID of a service template to use to create a new instance of a service
+      - ID of a service template to use to create a new instance of a service.
     type: int
   service_id:
     description:
-      - ID of a service instance that you would like to manage
+      - ID of a service instance that you would like to manage.
     type: int
   service_name:
     description:
-      - Name of a service instance that you would like to manage
+      - Name of a service instance that you would like to manage.
     type: str
   unique:
     description:
-      - Setting C(unique=true) will make sure that there is only one service instance running with a name set with C(service_name) when
+      - Setting I(unique=true) will make sure that there is only one service instance running with a name set with C(service_name) when
-      - instantiating a service from a template specified with C(template_id)/C(template_name). Check examples below.
+        instantiating a service from a template specified with I(template_id) or I(template_name). Check examples below.
     type: bool
     default: false
   state:
     description:
-      - C(present) - instantiate a service from a template specified with C(template_id)/C(template_name).
+      - C(present) - instantiate a service from a template specified with I(template_id) or I(template_name).
-      - C(absent) - terminate an instance of a service specified with C(service_id)/C(service_name).
+      - C(absent) - terminate an instance of a service specified with I(template_id) or I(template_name).
     choices: ["present", "absent"]
     default: present
     type: str
@@ -83,20 +83,20 @@ options:
     type: str
   owner_id:
     description:
-      - ID of the user which will be set as the owner of the service
+      - ID of the user which will be set as the owner of the service.
     type: int
   group_id:
     description:
-      - ID of the group which will be set as the group of the service
+      - ID of the group which will be set as the group of the service.
     type: int
   wait:
     description:
-      - Wait for the instance to reach RUNNING state after DEPLOYING or COOLDOWN state after SCALING
+      - Wait for the instance to reach RUNNING state after DEPLOYING or COOLDOWN state after SCALING.
     type: bool
     default: false
   wait_timeout:
     description:
-      - How long before wait gives up, in seconds
+      - How long before wait gives up, in seconds.
     default: 300
     type: int
   custom_attrs:
@@ -106,15 +106,15 @@ options:
     type: dict
   role:
     description:
-      - Name of the role whose cardinality should be changed
+      - Name of the role whose cardinality should be changed.
     type: str
   cardinality:
     description:
-      - Number of VMs for the specified role
+      - Number of VMs for the specified role.
     type: int
   force:
     description:
-      - Force the new cardinality even if it is outside the limits
+      - Force the new cardinality even if it is outside the limits.
     type: bool
     default: false
 author:

plugins/modules/cloud/rackspace/rax_cbs.py

@@ -18,34 +18,34 @@ options:
   description:
     type: str
     description:
-      - Description to give the volume being created
+      - Description to give the volume being created.
   image:
     type: str
     description:
-      - image to use for bootable volumes. Can be an C(id), C(human_id) or
+      - Image to use for bootable volumes. Can be an C(id), C(human_id) or
-        C(name). This option requires C(pyrax>=1.9.3)
+        C(name). This option requires C(pyrax>=1.9.3).
   meta:
     type: dict
     description:
-      - A hash of metadata to associate with the volume
+      - A hash of metadata to associate with the volume.
   name:
     type: str
     description:
-      - Name to give the volume being created
+      - Name to give the volume being created.
     required: true
   size:
     type: int
     description:
-      - Size of the volume to create in Gigabytes
+      - Size of the volume to create in Gigabytes.
     default: 100
   snapshot_id:
     type: str
     description:
-      - The id of the snapshot to create the volume from
+      - The id of the snapshot to create the volume from.
   state:
     type: str
     description:
-      - Indicate desired state of the resource
+      - Indicate desired state of the resource.
     choices:
       - present
       - absent
@@ -53,20 +53,20 @@ options:
   volume_type:
     type: str
     description:
-      - Type of the volume being created
+      - Type of the volume being created.
     choices:
       - SATA
       - SSD
     default: SATA
   wait:
     description:
-      - wait for the volume to be in state 'available' before returning
+      - Wait for the volume to be in state C(available) before returning.
     type: bool
     default: false
   wait_timeout:
     type: int
     description:
-      - how long before wait gives up, in seconds
+      - how long before wait gives up, in seconds.
     default: 300
 author:
     - "Christopher H. Laco (@claco)"

plugins/modules/net_tools/haproxy.py

@@ -21,7 +21,7 @@ notes:
       sockets configured for level 'admin'. For example, you can add the line
       'stats socket /var/run/haproxy.sock level admin' to the general section of
       haproxy.cfg. See U(http://haproxy.1wt.eu/download/1.5/doc/configuration.txt).
-    - Depends on netcat (nc) being available; you need to install the appropriate
+    - Depends on netcat (C(nc)) being available; you need to install the appropriate
       package for your operating system before this module can be used.
 options:
   backend:
@@ -33,7 +33,7 @@ options:
     description:
       - Wait until the server has no active connections or until the timeout
         determined by wait_interval and wait_retries is reached.
-      - Continue only after the status changes to 'MAINT'.
+      - Continue only after the status changes to C(MAINT).
       - This overrides the shutdown_sessions option.
     type: bool
     default: false
@@ -78,13 +78,13 @@ options:
     version_added: "1.0.0"
   fail_on_not_found:
     description:
-      - Fail whenever trying to enable/disable a backend host that does not exist
+      - Fail whenever trying to enable/disable a backend host that does not exist.
     type: bool
     default: false
   wait:
     description:
-      - Wait until the server reports a status of 'UP' when C(state=enabled),
+      - Wait until the server reports a status of C(UP) when I(state=enabled),
-        status of 'MAINT' when C(state=disabled) or status of 'DRAIN' when C(state=drain)
+        status of C(MAINT) when I(state=disabled) or status of C(DRAIN) when I(state=drain).
     type: bool
     default: false
   wait_interval:

plugins/modules/net_tools/netcup_dns.py

@@ -15,59 +15,59 @@ module: netcup_dns
 notes: []
 short_description: manage Netcup DNS records
 description:
-  - "Manages DNS records via the Netcup API, see the docs U(https://ccp.netcup.net/run/webservice/servers/endpoint.php)"
+  - "Manages DNS records via the Netcup API, see the docs U(https://ccp.netcup.net/run/webservice/servers/endpoint.php)."
 options:
   api_key:
     description:
-      - API key for authentication, must be obtained via the netcup CCP (U(https://ccp.netcup.net))
+      - "API key for authentication, must be obtained via the netcup CCP (U(https://ccp.netcup.net))."
     required: True
     type: str
   api_password:
     description:
-      - API password for authentication, must be obtained via the netcup CCP (https://ccp.netcup.net)
+      - "API password for authentication, must be obtained via the netcup CCP (U(https://ccp.netcup.net))."
     required: True
     type: str
   customer_id:
     description:
-      - Netcup customer id
+      - Netcup customer id.
     required: True
     type: int
   domain:
     description:
-      - Domainname the records should be added / removed
+      - Domainname the records should be added / removed.
     required: True
     type: str
   record:
     description:
-      - Record to add or delete, supports wildcard (*). Default is C(@) (e.g. the zone name)
+      - Record to add or delete, supports wildcard (*). Default is C(@) (e.g. the zone name).
     default: "@"
     aliases: [ name ]
     type: str
   type:
     description:
-      - Record type
+      - Record type.
     choices: ['A', 'AAAA', 'MX', 'CNAME', 'CAA', 'SRV', 'TXT', 'TLSA', 'NS', 'DS']
     required: True
     type: str
   value:
     description:
-      - Record value
+      - Record value.
     required: true
     type: str
   solo:
     type: bool
     default: False
     description:
-      - Whether the record should be the only one for that record type and record name. Only use with C(state=present)
+      - Whether the record should be the only one for that record type and record name. Only use with I(state=present).
       - This will delete all other records with the same record name and type.
   priority:
     description:
-      - Record priority. Required for C(type=MX)
+      - Record priority. Required for I(type=MX).
     required: False
     type: int
   state:
     description:
-      - Whether the record should exist or not
+      - Whether the record should exist or not.
     required: False
     default: present
     choices: [ 'present', 'absent' ]

plugins/modules/system/cronvar.py

@@ -33,16 +33,16 @@ options:
   value:
     description:
       - The value to set this variable to.
-      - Required if C(state=present).
+      - Required if I(state=present).
     type: str
   insertafter:
     description:
       - If specified, the variable will be inserted after the variable specified.
-      - Used with C(state=present).
+      - Used with I(state=present).
     type: str
   insertbefore:
     description:
-      - Used with C(state=present). If specified, the variable will be inserted
+      - Used with I(state=present). If specified, the variable will be inserted
         just before the variable specified.
     type: str
   state:

plugins/modules/system/filesystem.py

@@ -22,11 +22,11 @@ description:
 options:
   state:
     description:
-      - If C(state=present), the filesystem is created if it doesn't already
+      - If I(state=present), the filesystem is created if it doesn't already
         exist, that is the default behaviour if I(state) is omitted.
-      - If C(state=absent), filesystem signatures on I(dev) are wiped if it
+      - If I(state=absent), filesystem signatures on I(dev) are wiped if it
         contains a filesystem (as known by C(blkid)).
-      - When C(state=absent), all other options but I(dev) are ignored, and the
+      - When I(state=absent), all other options but I(dev) are ignored, and the
         module doesn't fail if the device I(dev) doesn't actually exist.
     type: str
     choices: [ present, absent ]
@@ -36,7 +36,7 @@ options:
     choices: [ btrfs, ext2, ext3, ext4, ext4dev, f2fs, lvm, ocfs2, reiserfs, xfs, vfat, swap, ufs ]
     description:
       - Filesystem type to be created. This option is required with
-        C(state=present) (or if I(state) is omitted).
+        I(state=present) (or if I(state) is omitted).
       - ufs support has been added in community.general 3.4.0.
     type: str
     aliases: [type]
@@ -65,12 +65,12 @@ options:
       - XFS Will only grow if mounted. Currently, the module is based on commands
         from C(util-linux) package to perform operations, so resizing of XFS is
         not supported on FreeBSD systems.
-      - vFAT will likely fail if fatresize < 1.04.
+      - vFAT will likely fail if C(fatresize < 1.04).
     type: bool
     default: false
   opts:
     description:
-      - List of options to be passed to mkfs command.
+      - List of options to be passed to C(mkfs) command.
     type: str
 requirements:
   - Uses specific tools related to the I(fstype) for creating or resizing a

plugins/modules/web_infrastructure/deploy_helper.py

@@ -20,8 +20,8 @@ description:
   - The Deploy Helper manages some of the steps common in deploying software.
     It creates a folder structure, manages a symlink for the current release
     and cleans up old releases.
-  - "Running it with the C(state=query) or C(state=present) will return the C(deploy_helper) fact.
+  - "Running it with the I(state=query) or I(state=present) will return the C(deploy_helper) fact.
-    C(project_path), whatever you set in the path parameter,
+    C(project_path), whatever you set in the I(path) parameter,
     C(current_path), the path to the symlink that points to the active release,
     C(releases_path), the path to the folder to keep releases in,
     C(shared_path), the path to the folder to keep shared resources in,
@@ -37,40 +37,40 @@ options:
     required: True
     aliases: ['dest']
     description:
-      - the root path of the project. Alias I(dest).
+      - The root path of the project.
         Returned in the C(deploy_helper.project_path) fact.
 
   state:
     type: str
     description:
-      - the state of the project.
+      - The state of the project.
         C(query) will only gather facts,
         C(present) will create the project I(root) folder, and in it the I(releases) and I(shared) folders,
         C(finalize) will remove the unfinished_filename file, create a symlink to the newly
           deployed release and optionally clean old releases,
         C(clean) will remove failed & old releases,
-        C(absent) will remove the project folder (synonymous to the M(ansible.builtin.file) module with C(state=absent))
+        C(absent) will remove the project folder (synonymous to the M(ansible.builtin.file) module with I(state=absent)).
     choices: [ present, finalize, absent, clean, query ]
     default: present
 
   release:
     type: str
     description:
-      - the release version that is being deployed. Defaults to a timestamp format %Y%m%d%H%M%S (i.e. '20141119223359').
+      - The release version that is being deployed. Defaults to a timestamp format %Y%m%d%H%M%S (i.e. '20141119223359').
-        This parameter is optional during C(state=present), but needs to be set explicitly for C(state=finalize).
+        This parameter is optional during I(state=present), but needs to be set explicitly for I(state=finalize).
-        You can use the generated fact C(release={{ deploy_helper.new_release }}).
+        You can use the generated fact I(release={{ deploy_helper.new_release }}).
 
   releases_path:
     type: str
     description:
-      - the name of the folder that will hold the releases. This can be relative to C(path) or absolute.
+      - The name of the folder that will hold the releases. This can be relative to I(path) or absolute.
         Returned in the C(deploy_helper.releases_path) fact.
     default: releases
 
   shared_path:
     type: path
     description:
-      - the name of the folder that will hold the shared resources. This can be relative to C(path) or absolute.
+      - The name of the folder that will hold the shared resources. This can be relative to I(path) or absolute.
         If this is set to an empty string, no shared folder will be created.
         Returned in the C(deploy_helper.shared_path) fact.
     default: shared
@@ -78,38 +78,38 @@ options:
   current_path:
     type: path
     description:
-      - the name of the symlink that is created when the deploy is finalized. Used in C(finalize) and C(clean).
+      - The name of the symlink that is created when the deploy is finalized. Used in I(finalize) and I(clean).
         Returned in the C(deploy_helper.current_path) fact.
     default: current
 
   unfinished_filename:
     type: str
     description:
-      - the name of the file that indicates a deploy has not finished. All folders in the releases_path that
+      - The name of the file that indicates a deploy has not finished. All folders in the I(releases_path) that
-        contain this file will be deleted on C(state=finalize) with clean=True, or C(state=clean). This file is
+        contain this file will be deleted on I(state=finalize) with I(clean=True), or I(state=clean). This file is
-        automatically deleted from the I(new_release_path) during C(state=finalize).
+        automatically deleted from the I(new_release_path) during I(state=finalize).
     default: DEPLOY_UNFINISHED
 
   clean:
     description:
-      - Whether to run the clean procedure in case of C(state=finalize).
+      - Whether to run the clean procedure in case of I(state=finalize).
     type: bool
     default: true
 
   keep_releases:
     type: int
     description:
-      - the number of old releases to keep when cleaning. Used in C(finalize) and C(clean). Any unfinished builds
+      - The number of old releases to keep when cleaning. Used in I(finalize) and I(clean). Any unfinished builds
         will be deleted first, so only correct releases will count. The current version will not count.
     default: 5
 
 notes:
-  - Facts are only returned for C(state=query) and C(state=present). If you use both, you should pass any overridden
+  - Facts are only returned for I(state=query) and I(state=present). If you use both, you should pass any overridden
     parameters to both calls, otherwise the second call will overwrite the facts of the first one.
-  - When using C(state=clean), the releases are ordered by I(creation date). You should be able to switch to a
+  - When using I(state=clean), the releases are ordered by I(creation date). You should be able to switch to a
     new naming strategy without problems.
   - Because of the default behaviour of generating the I(new_release) fact, this module will not be idempotent
-    unless you pass your own release name with C(release). Due to the nature of deploying software, this should not
+    unless you pass your own release name with I(release). Due to the nature of deploying software, this should not
     be much of a problem.
 extends_documentation_fragment: files
 '''

plugins/modules/web_infrastructure/jenkins_job.py

@@ -23,14 +23,14 @@ options:
     description:
       - config in XML format.
       - Required if job does not yet exist.
-      - Mutually exclusive with C(enabled).
+      - Mutually exclusive with I(enabled).
-      - Considered if C(state=present).
+      - Considered if I(state=present).
     required: false
   enabled:
     description:
       - Whether the job should be enabled or disabled.
-      - Mutually exclusive with C(config).
+      - Mutually exclusive with I(config).
-      - Considered if C(state=present).
+      - Considered if I(state=present).
     type: bool
     required: false
   name: