adjust doc style - batch 2 (#9447)

plugins/modules/clc_publicip.py

@@ -35,13 +35,13 @@ options:
     elements: int
   server_ids:
     description:
-      - A list of servers to create public ips on.
+      - A list of servers to create public IPs on.
     type: list
     required: true
     elements: str
   state:
     description:
-      - Determine whether to create or delete public IPs. If V(present) module will not create a second public ip if one already
+      - Determine whether to create or delete public IPs. If V(present) module will not create a second public IP if one already
         exists.
     type: str
     default: present

plugins/modules/clc_server.py

@@ -30,7 +30,7 @@ options:
     default: []
   add_public_ip:
     description:
-      - Whether to add a public ip to the server.
+      - Whether to add a public IP to the server.
     type: bool
     default: false
   alias:
@@ -134,13 +134,13 @@ options:
     type: str
   public_ip_protocol:
     description:
-      - The protocol to use for the public ip if add_public_ip is set to True.
+      - The protocol to use for the public ip if O(add_public_ip=true).
     type: str
     default: 'TCP'
     choices: ['TCP', 'UDP', 'ICMP']
   public_ip_ports:
     description:
-      - A list of ports to allow on the firewall to the servers public ip, if add_public_ip is set to True.
+      - A list of ports to allow on the firewall to the servers public IP, if O(add_public_ip=true).
     type: list
     elements: dict
     default: []
@@ -150,7 +150,7 @@ options:
     type: str
   server_ids:
     description:
-      - Required for started, stopped, and absent states. A list of server Ids to insure are started, stopped, or absent.
+      - Required for started, stopped, and absent states. A list of server IDs to ensure are started, stopped, or absent.
     type: list
     default: []
     elements: str

plugins/modules/cloudflare_dns.py

@@ -14,7 +14,7 @@ author:
   - Michael Gruener (@mgruener)
 short_description: Manage Cloudflare DNS records
 description:
-  - 'Manages dns records using the Cloudflare API, see the docs: U(https://api.cloudflare.com/).'
+  - 'Manages DNS records using the Cloudflare API, see the docs: U(https://api.cloudflare.com/).'
 extends_documentation_fragment:
   - community.general.attributes
 attributes:
@@ -26,7 +26,7 @@ options:
   api_token:
     description:
       - API token.
-      - Required for api token authentication.
+      - Required for API token authentication.
       - "You can obtain your API token from the bottom of the Cloudflare 'My Account' page, found here: U(https://dash.cloudflare.com/)."
       - Can be specified in E(CLOUDFLARE_TOKEN) environment variable since community.general 2.0.0.
     type: str
@@ -34,7 +34,7 @@ options:
   account_api_key:
     description:
       - Account API key.
-      - Required for api keys authentication.
+      - Required for API keys authentication.
       - "You can obtain your API key from the bottom of the Cloudflare 'My Account' page, found here: U(https://dash.cloudflare.com/)."
     type: str
     aliases: [account_api_token]

plugins/modules/etcd3.py

@@ -15,7 +15,7 @@ short_description: Set or delete key value pairs from an etcd3 cluster
 requirements:
   - etcd3
 description:
-  - Sets or deletes values in etcd3 cluster using its v3 api.
+  - Sets or deletes values in etcd3 cluster using its v3 API.
   - Needs python etcd3 lib to work.
 extends_documentation_fragment:
   - community.general.attributes

plugins/modules/gitlab_hook.py

@@ -153,7 +153,7 @@ msg:
   sample: "Success"
 
 result:
-  description: Json parsed response from the server.
+  description: JSON parsed response from the server.
   returned: always
   type: dict
 

plugins/modules/homectl.py

@@ -218,7 +218,7 @@ EXAMPLES = r"""
 
 RETURN = r"""
 data:
-    description: A json dictionary returned from C(homectl inspect -j).
+    description: Dictionary returned from C(homectl inspect -j).
     returned: success
     type: dict
     sample: {

plugins/modules/infinity.py

@@ -110,7 +110,7 @@ network_id:
   type: str
   sample: '1501'
 ip_info:
-  description: When reserve next available ip address from a network, the ip address info ) is returned.
+  description: When reserve next available IP address from a network, the IP address info is returned.
   returned: success
   type: str
   sample: '{"address": "192.168.10.3", "hostname": "", "FQDN": "", "domainname": "", "id": 3229}'

plugins/modules/ipinfoio_facts.py

@@ -33,7 +33,7 @@ options:
     default: "ansible-ipinfoio-module/0.0.1"
     type: str
 notes:
-  - Check http://ipinfo.io/ for more information.
+  - Check U(http://ipinfo.io/) for more information.
 """
 
 EXAMPLES = r"""
@@ -44,7 +44,7 @@ EXAMPLES = r"""
 
 RETURN = r"""
 ansible_facts:
-  description: "Dictionary of ip geolocation facts for a host's IP address."
+  description: "Dictionary of IP geolocation facts for a host's IP address."
   returned: changed
   type: complex
   contains:

plugins/modules/ipmi_boot.py

@@ -24,7 +24,7 @@ attributes:
 options:
   name:
     description:
-      - Hostname or ip address of the BMC.
+      - Hostname or IP address of the BMC.
     required: true
     type: str
   port:

plugins/modules/ipmi_power.py

@@ -24,7 +24,7 @@ attributes:
 options:
   name:
     description:
-      - Hostname or ip address of the BMC.
+      - Hostname or IP address of the BMC.
     required: true
     type: str
   port:

plugins/modules/jenkins_plugin.py

@@ -78,7 +78,7 @@ options:
     type: list
     elements: str
     description:
-      - A list of URL segment(s) to retrieve the update center json file from.
+      - A list of URL segment(s) to retrieve the update center JSON file from.
     default: ['update-center.json', 'updates/update-center.json']
     version_added: 3.3.0
   latest_plugins_url_segments:

plugins/modules/librato_annotation.py

@@ -11,7 +11,7 @@ __metaclass__ = type
 
 DOCUMENTATION = r"""
 module: librato_annotation
-short_description: Create an annotation in librato
+short_description: Create an annotation in Librato
 description:
   - Create an annotation event on the given annotation stream :name. If the annotation stream does not exist, it will be created automatically.
 author: "Seth Edwards (@Sedward)"
@@ -32,7 +32,7 @@ options:
   api_key:
     type: str
     description:
-      - Librato account api key.
+      - Librato account API key.
     required: true
   name:
     type: str

plugins/modules/lxc_container.py

@@ -374,12 +374,12 @@ lxc_container:
   type: complex
   contains:
     name:
-      description: Name of the lxc container.
+      description: Name of the LXC container.
       returned: success
       type: str
       sample: test_host
     init_pid:
-      description: Pid of the lxc init process.
+      description: Pid of the LXC init process.
       returned: success
       type: int
       sample: 19786
@@ -389,7 +389,7 @@ lxc_container:
       type: list
       sample: ["eth0", "lo"]
     ips:
-      description: List of ips.
+      description: List of IPs.
       returned: success
       type: list
       sample: ["10.0.3.3"]

plugins/modules/mattermost.py

@@ -37,7 +37,7 @@ options:
   api_key:
     type: str
     description:
-      - Mattermost webhook api key. Log into your mattermost site, go to Menu -> Integration -> Incoming Webhook -> Add Incoming Webhook. This
+      - Mattermost webhook API key. Log into your Mattermost site, go to Menu -> Integration -> Incoming Webhook -> Add Incoming Webhook. This
         will give you full URL. O(api_key) is the last part. U(http://mattermost.example.com/hooks/API_KEY).
     required: true
   text:

plugins/modules/oneandone_public_ip.py

@@ -22,7 +22,7 @@ attributes:
 options:
   state:
     description:
-      - Define a public ip state to create, remove, or update.
+      - Define a public IP state to create, remove, or update.
     type: str
     required: false
     default: 'present'
@@ -108,7 +108,7 @@ EXAMPLES = r"""
 
 RETURN = r"""
 public_ip:
-  description: Information about the public ip that was processed.
+  description: Information about the public IP that was processed.
   type: dict
   sample: '{"id": "F77CC589EBC120905B4F4719217BFF6D", "ip": "10.5.132.106"}'
   returned: always

plugins/modules/ovh_ip_loadbalancing_backend.py

@@ -16,7 +16,7 @@ description:
   - Manage OVH (French European hosting provider) LoadBalancing IP backends.
 author: Pascal Heraud (@pascalheraud)
 notes:
-  - Uses the python OVH Api U(https://github.com/ovh/python-ovh). You have to create an application (a key and secret) with a consumer key as
+  - Uses the Python OVH API U(https://github.com/ovh/python-ovh). You have to create an application (a key and secret) with a consumer key as
     described into U(https://docs.ovh.com/gb/en/customer/first-steps-with-ovh-api/).
 requirements:
   - ovh >  0.3.5
@@ -31,7 +31,7 @@ options:
   name:
     required: true
     description:
-      - Name of the LoadBalancing internal name (ip-X.X.X.X).
+      - Name of the LoadBalancing internal name (V(ip-X.X.X.X)).
     type: str
   backend:
     required: true
@@ -58,7 +58,7 @@ options:
   endpoint:
     required: true
     description:
-      - The endpoint to use ( for instance ovh-eu).
+      - The endpoint to use (for instance V(ovh-eu)).
     type: str
   application_key:
     required: true

plugins/modules/packet_project.py

@@ -49,7 +49,7 @@ options:
 
   auth_token:
     description:
-      - Packet api token. You can also supply it in environment variable E(PACKET_API_TOKEN).
+      - Packet API token. You can also supply it in environment variable E(PACKET_API_TOKEN).
     type: str
 
   name:

plugins/modules/proxmox_kvm.py

@@ -230,13 +230,13 @@ options:
   ipconfig:
     description:
       - 'Cloud-init: Set the IP configuration.'
-      - A hash/dictionary of network ip configurations. O(ipconfig='{"key":"value", "key":"value"}').
+      - A hash/dictionary of network IP configurations. O(ipconfig='{"key":"value", "key":"value"}').
       - Keys allowed are - V(ipconfig[n]) where 0 ≤ n ≤ network interfaces.
       - Values allowed are - V("[gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,ip=<IPv4Format/CIDR>] [,ip6=<IPv6Format/CIDR>]").
       - 'Cloud-init: Specify IP addresses and gateways for the corresponding interface.'
       - IP addresses use CIDR notation, gateways are optional but they should be in the same subnet of specified IP address.
-      - The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided.
+      - The special string V(dhcp) can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided.
-      - For IPv6 the special string 'auto' can be used to use stateless autoconfiguration.
+      - For IPv6 the special string V(auto) can be used to use stateless autoconfiguration.
       - If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4.
     type: dict
     version_added: 1.3.0
@@ -315,12 +315,12 @@ options:
   numa:
     description:
       - A hash/dictionaries of NUMA topology. O(numa='{"key":"value", "key":"value"}').
-      - Keys allowed are - C(numa[n]) where 0 ≤ n ≤ N.
+      - Keys allowed are - V(numa[n]) where 0 ≤ n ≤ N.
-      - Values allowed are - C("cpu="<id[-id];...>",hostnodes="<id[-id];...>",memory="number",policy="(bind|interleave|preferred)"").
+      - Values allowed are - V("cpu="<id[-id];...>",hostnodes="<id[-id];...>",memory="number",policy="(bind|interleave|preferred)"").
-      - C(cpus) CPUs accessing this NUMA node.
+      - V(cpus) CPUs accessing this NUMA node.
-      - C(hostnodes) Host NUMA nodes to use.
+      - V(hostnodes) Host NUMA nodes to use.
-      - C(memory) Amount of memory this NUMA node provides.
+      - V(memory) Amount of memory this NUMA node provides.
-      - C(policy) NUMA allocation policy.
+      - V(policy) NUMA allocation policy.
     type: dict
   numa_enabled:
     description:
@@ -536,17 +536,17 @@ options:
     type: int
   vga:
     description:
-      - Select VGA type. If you want to use high resolution modes (>= 1280x1024x16) then you should use option 'std' or 'vmware'.
+      - Select VGA type. If you want to use high resolution modes (>= 1280x1024x16) then you should use option V(std) or V(vmware).
     type: str
     choices: ['std', 'cirrus', 'vmware', 'qxl', 'serial0', 'serial1', 'serial2', 'serial3', 'qxl2', 'qxl3', 'qxl4']
   virtio:
     description:
       - A hash/dictionary of volume used as VIRTIO hard disk. O(virtio='{"key":"value", "key":"value"}').
       - Keys allowed are - V(virtio[n]) where 0 ≤ n ≤ 15.
-      - Values allowed are - V("storage:size,format=value").
+      - Values allowed are - V(storage:size,format=value).
       - V(storage) is the storage identifier where to create the disk.
       - V(size) is the size of the disk in GB.
-      - V(format) is the drive's backing file's data format. C(qcow2|raw|subvol). Please refer to the Proxmox VE Administrator Guide, section
+      - V(format) is the drive's backing file's data format. V(qcow2|raw|subvol). Please refer to the Proxmox VE Administrator Guide, section
         Proxmox VE Storage (see U(https://pve.proxmox.com/pve-docs/chapter-pvesm.html) for the latest version, tables 3 to 14) to find out format
         supported by the provided storage backend.
     type: dict

plugins/modules/riak.py

@@ -37,7 +37,7 @@ options:
     type: path
   http_conn:
     description:
-      - The ip address and port that is listening for Riak HTTP queries.
+      - The IP address and port that is listening for Riak HTTP queries.
     default: 127.0.0.1:8098
     type: str
   target_node:

plugins/modules/scaleway_ip_info.py

@@ -10,9 +10,9 @@ __metaclass__ = type
 
 DOCUMENTATION = r"""
 module: scaleway_ip_info
-short_description: Gather information about the Scaleway ips available
+short_description: Gather information about the Scaleway IPs available
 description:
-  - Gather information about the Scaleway ips available.
+  - Gather information about the Scaleway IPs available.
 author:
   - "Yanis Guenane (@Spredzy)"
   - "Remy Leone (@remyleone)"
@@ -39,7 +39,7 @@ options:
 """
 
 EXAMPLES = r"""
-- name: Gather Scaleway ips information
+- name: Gather Scaleway IPs information
   community.general.scaleway_ip_info:
     region: par1
   register: result

plugins/modules/sendgrid.py

@@ -76,7 +76,7 @@ options:
   from_name:
     type: str
     description:
-      - The name you want to appear in the from field, i.e 'John Doe'.
+      - The name you want to appear in the from field, for example V(John Doe).
   html_body:
     description:
       - Whether the body is html content that should be rendered.