1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00

Short descriptions (batch3) - massive fix on Capitalization and trailing period (#5521)

* short_description fix batch 3

* Update plugins/modules/telegram.py

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

Co-authored-by: Felix Fontein <felix@fontein.de>
This commit is contained in:
Alexei Znamensky 2022-11-10 09:09:09 +13:00 committed by GitHub
parent 0e9cd5e6b6
commit 6b20572ea1
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
48 changed files with 48 additions and 48 deletions

View file

@ -14,7 +14,7 @@ DOCUMENTATION = '''
--- ---
module: pulp_repo module: pulp_repo
author: "Joe Adams (@sysadmind)" author: "Joe Adams (@sysadmind)"
short_description: Add or remove Pulp repos from a remote host. short_description: Add or remove Pulp repos from a remote host
description: description:
- Add or remove Pulp repos from a remote host. - Add or remove Pulp repos from a remote host.
- Note, this is for Pulp 2 only. - Note, this is for Pulp 2 only.

View file

@ -11,7 +11,7 @@ __metaclass__ = type
DOCUMENTATION = ''' DOCUMENTATION = '''
--- ---
module: rax module: rax
short_description: create / delete an instance in Rackspace Public Cloud short_description: Create / delete an instance in Rackspace Public Cloud
description: description:
- creates / deletes a Rackspace Public Cloud instance and optionally - creates / deletes a Rackspace Public Cloud instance and optionally
waits for it to be 'running'. waits for it to be 'running'.

View file

@ -11,7 +11,7 @@ __metaclass__ = type
DOCUMENTATION = ''' DOCUMENTATION = '''
--- ---
module: rax_cdb module: rax_cdb
short_description: create/delete or resize a Rackspace Cloud Databases instance short_description: Create/delete or resize a Rackspace Cloud Databases instance
description: description:
- creates / deletes or resize a Rackspace Cloud Databases instance - creates / deletes or resize a Rackspace Cloud Databases instance
and optionally waits for it to be 'running'. The name option needs to be and optionally waits for it to be 'running'. The name option needs to be

View file

@ -10,7 +10,7 @@ __metaclass__ = type
DOCUMENTATION = ''' DOCUMENTATION = '''
module: rax_cdb_database module: rax_cdb_database
short_description: 'create / delete a database in the Cloud Databases' short_description: Create / delete a database in the Cloud Databases
description: description:
- create / delete a database in the Cloud Databases. - create / delete a database in the Cloud Databases.
options: options:

View file

@ -11,7 +11,7 @@ __metaclass__ = type
DOCUMENTATION = ''' DOCUMENTATION = '''
--- ---
module: rax_cdb_user module: rax_cdb_user
short_description: create / delete a Rackspace Cloud Database short_description: Create / delete a Rackspace Cloud Database
description: description:
- create / delete a database in the Cloud Databases. - create / delete a database in the Cloud Databases.
options: options:

View file

@ -11,7 +11,7 @@ __metaclass__ = type
DOCUMENTATION = ''' DOCUMENTATION = '''
--- ---
module: rax_clb module: rax_clb
short_description: create / delete a load balancer in Rackspace Public Cloud short_description: Create / delete a load balancer in Rackspace Public Cloud
description: description:
- creates / deletes a Rackspace Public Cloud load balancer. - creates / deletes a Rackspace Public Cloud load balancer.
options: options:

View file

@ -11,7 +11,7 @@ __metaclass__ = type
DOCUMENTATION = ''' DOCUMENTATION = '''
--- ---
module: rax_clb_nodes module: rax_clb_nodes
short_description: add, modify and remove nodes from a Rackspace Cloud Load Balancer short_description: Add, modify and remove nodes from a Rackspace Cloud Load Balancer
description: description:
- Adds, modifies and removes nodes from a Rackspace Cloud Load Balancer - Adds, modifies and removes nodes from a Rackspace Cloud Load Balancer
options: options:

View file

@ -10,7 +10,7 @@ __metaclass__ = type
DOCUMENTATION = ''' DOCUMENTATION = '''
module: rax_clb_ssl module: rax_clb_ssl
short_description: Manage SSL termination for a Rackspace Cloud Load Balancer. short_description: Manage SSL termination for a Rackspace Cloud Load Balancer
description: description:
- Set up, reconfigure, or remove SSL termination for an existing load balancer. - Set up, reconfigure, or remove SSL termination for an existing load balancer.
options: options:

View file

@ -11,7 +11,7 @@ __metaclass__ = type
DOCUMENTATION = ''' DOCUMENTATION = '''
--- ---
module: rax_mon_alarm module: rax_mon_alarm
short_description: Create or delete a Rackspace Cloud Monitoring alarm. short_description: Create or delete a Rackspace Cloud Monitoring alarm
description: description:
- Create or delete a Rackspace Cloud Monitoring alarm that associates an - Create or delete a Rackspace Cloud Monitoring alarm that associates an
existing rax_mon_entity, rax_mon_check, and rax_mon_notification_plan with existing rax_mon_entity, rax_mon_check, and rax_mon_notification_plan with

View file

@ -11,7 +11,7 @@ __metaclass__ = type
DOCUMENTATION = ''' DOCUMENTATION = '''
--- ---
module: rax_mon_notification module: rax_mon_notification
short_description: Create or delete a Rackspace Cloud Monitoring notification. short_description: Create or delete a Rackspace Cloud Monitoring notification
description: description:
- Create or delete a Rackspace Cloud Monitoring notification that specifies a - Create or delete a Rackspace Cloud Monitoring notification that specifies a
channel that can be used to communicate alarms, such as email, webhooks, or channel that can be used to communicate alarms, such as email, webhooks, or

View file

@ -11,7 +11,7 @@ __metaclass__ = type
DOCUMENTATION = ''' DOCUMENTATION = '''
--- ---
module: rax_network module: rax_network
short_description: create / delete an isolated network in Rackspace Public Cloud short_description: Create / delete an isolated network in Rackspace Public Cloud
description: description:
- creates / deletes a Rackspace Public Cloud isolated network. - creates / deletes a Rackspace Public Cloud isolated network.
options: options:

View file

@ -11,7 +11,7 @@ __metaclass__ = type
DOCUMENTATION = ''' DOCUMENTATION = '''
--- ---
module: rax_queue module: rax_queue
short_description: create / delete a queue in Rackspace Public Cloud short_description: Create / delete a queue in Rackspace Public Cloud
description: description:
- creates / deletes a Rackspace Public Cloud queue. - creates / deletes a Rackspace Public Cloud queue.
options: options:

View file

@ -15,7 +15,7 @@ DOCUMENTATION = '''
--- ---
module: rundeck_acl_policy module: rundeck_acl_policy
short_description: Manage Rundeck ACL policies. short_description: Manage Rundeck ACL policies
description: description:
- Create, update and remove Rundeck ACL policies through HTTP API. - Create, update and remove Rundeck ACL policies through HTTP API.
author: "Loic Blot (@nerzhul)" author: "Loic Blot (@nerzhul)"

View file

@ -17,7 +17,7 @@ DOCUMENTATION = '''
--- ---
module: rundeck_project module: rundeck_project
short_description: Manage Rundeck projects. short_description: Manage Rundeck projects
description: description:
- Create and remove Rundeck projects through HTTP API. - Create and remove Rundeck projects through HTTP API.
author: "Loic Blot (@nerzhul)" author: "Loic Blot (@nerzhul)"

View file

@ -12,7 +12,7 @@ __metaclass__ = type
DOCUMENTATION = ''' DOCUMENTATION = '''
--- ---
module: say module: say
short_description: Makes a computer to speak. short_description: Makes a computer to speak
description: description:
- makes a computer speak! Amuse your friends, annoy your coworkers! - makes a computer speak! Amuse your friends, annoy your coworkers!
notes: notes:

View file

@ -11,7 +11,7 @@ __metaclass__ = type
DOCUMENTATION = r''' DOCUMENTATION = r'''
--- ---
module: scaleway_image_info module: scaleway_image_info
short_description: Gather information about the Scaleway images available. short_description: Gather information about the Scaleway images available
description: description:
- Gather information about the Scaleway images available. - Gather information about the Scaleway images available.
author: author:

View file

@ -11,7 +11,7 @@ __metaclass__ = type
DOCUMENTATION = r''' DOCUMENTATION = r'''
--- ---
module: scaleway_ip_info module: scaleway_ip_info
short_description: Gather information about the Scaleway ips available. short_description: Gather information about the Scaleway ips available
description: description:
- Gather information about the Scaleway ips available. - Gather information about the Scaleway ips available.
author: author:

View file

@ -11,7 +11,7 @@ __metaclass__ = type
DOCUMENTATION = r''' DOCUMENTATION = r'''
--- ---
module: scaleway_organization_info module: scaleway_organization_info
short_description: Gather information about the Scaleway organizations available. short_description: Gather information about the Scaleway organizations available
description: description:
- Gather information about the Scaleway organizations available. - Gather information about the Scaleway organizations available.
author: author:

View file

@ -11,7 +11,7 @@ __metaclass__ = type
DOCUMENTATION = r''' DOCUMENTATION = r'''
--- ---
module: scaleway_security_group_info module: scaleway_security_group_info
short_description: Gather information about the Scaleway security groups available. short_description: Gather information about the Scaleway security groups available
description: description:
- Gather information about the Scaleway security groups available. - Gather information about the Scaleway security groups available.
author: author:

View file

@ -11,7 +11,7 @@ __metaclass__ = type
DOCUMENTATION = r''' DOCUMENTATION = r'''
--- ---
module: scaleway_server_info module: scaleway_server_info
short_description: Gather information about the Scaleway servers available. short_description: Gather information about the Scaleway servers available
description: description:
- Gather information about the Scaleway servers available. - Gather information about the Scaleway servers available.
author: author:

View file

@ -11,7 +11,7 @@ __metaclass__ = type
DOCUMENTATION = r''' DOCUMENTATION = r'''
--- ---
module: scaleway_snapshot_info module: scaleway_snapshot_info
short_description: Gather information about the Scaleway snapshots available. short_description: Gather information about the Scaleway snapshots available
description: description:
- Gather information about the Scaleway snapshot available. - Gather information about the Scaleway snapshot available.
author: author:

View file

@ -11,7 +11,7 @@ __metaclass__ = type
DOCUMENTATION = r''' DOCUMENTATION = r'''
--- ---
module: scaleway_volume_info module: scaleway_volume_info
short_description: Gather information about the Scaleway volumes available. short_description: Gather information about the Scaleway volumes available
description: description:
- Gather information about the Scaleway volumes available. - Gather information about the Scaleway volumes available.
author: author:

View file

@ -11,7 +11,7 @@ __metaclass__ = type
DOCUMENTATION = ''' DOCUMENTATION = '''
--- ---
module: sl_vm module: sl_vm
short_description: create or cancel a virtual instance in SoftLayer short_description: Create or cancel a virtual instance in SoftLayer
description: description:
- Creates or cancels SoftLayer instances. - Creates or cancels SoftLayer instances.
- When created, optionally waits for it to be 'running'. - When created, optionally waits for it to be 'running'.

View file

@ -12,7 +12,7 @@ __metaclass__ = type
DOCUMENTATION = ''' DOCUMENTATION = '''
--- ---
module: smartos_image_info module: smartos_image_info
short_description: Get SmartOS image details. short_description: Get SmartOS image details
description: description:
- Retrieve information about all installed images on SmartOS. - Retrieve information about all installed images on SmartOS.
- This module was called C(smartos_image_facts) before Ansible 2.9, returning C(ansible_facts). - This module was called C(smartos_image_facts) before Ansible 2.9, returning C(ansible_facts).

View file

@ -12,7 +12,7 @@ __metaclass__ = type
DOCUMENTATION = ''' DOCUMENTATION = '''
--- ---
module: spectrum_device module: spectrum_device
short_description: Creates/deletes devices in CA Spectrum. short_description: Creates/deletes devices in CA Spectrum
description: description:
- This module allows you to create and delete devices in CA Spectrum U(https://www.ca.com/us/products/ca-spectrum.html). - This module allows you to create and delete devices in CA Spectrum U(https://www.ca.com/us/products/ca-spectrum.html).
- Tested on CA Spectrum 9.4.2, 10.1.1 and 10.2.1 - Tested on CA Spectrum 9.4.2, 10.1.1 and 10.2.1

View file

@ -12,7 +12,7 @@ __metaclass__ = type
DOCUMENTATION = r''' DOCUMENTATION = r'''
--- ---
module: spectrum_model_attrs module: spectrum_model_attrs
short_description: Enforce a model's attributes in CA Spectrum. short_description: Enforce a model's attributes in CA Spectrum
description: description:
- This module can be used to enforce a model's attributes in CA Spectrum. - This module can be used to enforce a model's attributes in CA Spectrum.
version_added: 2.5.0 version_added: 2.5.0

View file

@ -13,7 +13,7 @@ DOCUMENTATION = '''
module: svc module: svc
author: author:
- Brian Coca (@bcoca) - Brian Coca (@bcoca)
short_description: Manage daemontools services short_description: Manage daemontools services
description: description:
- Controls daemontools services on remote hosts using the svc utility. - Controls daemontools services on remote hosts using the svc utility.
options: options:

View file

@ -13,7 +13,7 @@ __metaclass__ = type
DOCUMENTATION = ''' DOCUMENTATION = '''
--- ---
module: swupd module: swupd
short_description: Manages updates and bundles in ClearLinux systems. short_description: Manages updates and bundles in ClearLinux systems
description: description:
- Manages updates and bundles with the swupd bundle manager, which is used by the - Manages updates and bundles with the swupd bundle manager, which is used by the
Clear Linux Project for Intel Architecture. Clear Linux Project for Intel Architecture.

View file

@ -16,7 +16,7 @@ author:
- "Artem Feofanov (@tyouxa)" - "Artem Feofanov (@tyouxa)"
- "Nikolai Lomov (@lomserman)" - "Nikolai Lomov (@lomserman)"
short_description: module for sending notifications via telegram short_description: Send notifications via telegram
description: description:
- Send notifications via telegram bot, to a verified group or user. - Send notifications via telegram bot, to a verified group or user.

View file

@ -12,7 +12,7 @@ __metaclass__ = type
DOCUMENTATION = ''' DOCUMENTATION = '''
--- ---
module: twilio module: twilio
short_description: Sends a text message to a mobile phone through Twilio. short_description: Sends a text message to a mobile phone through Twilio
description: description:
- Sends a text message to a phone number through the Twilio messaging API. - Sends a text message to a phone number through the Twilio messaging API.
notes: notes:

View file

@ -15,7 +15,7 @@ module: utm_aaa_group
author: author:
- Johannes Brunswicker (@MatrixCrawler) - Johannes Brunswicker (@MatrixCrawler)
short_description: Create, update or destroy an aaa group object in Sophos UTM. short_description: Create, update or destroy an aaa group object in Sophos UTM
description: description:
- Create, update or destroy an aaa group object in Sophos UTM. - Create, update or destroy an aaa group object in Sophos UTM.

View file

@ -17,7 +17,7 @@ module: utm_aaa_group_info
author: author:
- Johannes Brunswicker (@MatrixCrawler) - Johannes Brunswicker (@MatrixCrawler)
short_description: get info for reverse_proxy frontend entry in Sophos UTM short_description: Get info for reverse_proxy frontend entry in Sophos UTM
description: description:
- get info for a reverse_proxy frontend entry in SOPHOS UTM. - get info for a reverse_proxy frontend entry in SOPHOS UTM.

View file

@ -16,7 +16,7 @@ module: utm_ca_host_key_cert
author: author:
- Stephan Schwarz (@stearz) - Stephan Schwarz (@stearz)
short_description: create, update or destroy ca host_key_cert entry in Sophos UTM short_description: Create, update or destroy ca host_key_cert entry in Sophos UTM
description: description:
- Create, update or destroy a ca host_key_cert entry in SOPHOS UTM. - Create, update or destroy a ca host_key_cert entry in SOPHOS UTM.

View file

@ -15,7 +15,7 @@ module: utm_dns_host
author: author:
- Johannes Brunswicker (@MatrixCrawler) - Johannes Brunswicker (@MatrixCrawler)
short_description: create, update or destroy dns entry in Sophos UTM short_description: Create, update or destroy dns entry in Sophos UTM
description: description:
- Create, update or destroy a dns entry in SOPHOS UTM. - Create, update or destroy a dns entry in SOPHOS UTM.

View file

@ -16,7 +16,7 @@ module: utm_proxy_auth_profile
author: author:
- Stephan Schwarz (@stearz) - Stephan Schwarz (@stearz)
short_description: create, update or destroy reverse_proxy auth_profile entry in Sophos UTM short_description: Create, update or destroy reverse_proxy auth_profile entry in Sophos UTM
description: description:
- Create, update or destroy a reverse_proxy auth_profile entry in SOPHOS UTM. - Create, update or destroy a reverse_proxy auth_profile entry in SOPHOS UTM.

View file

@ -16,7 +16,7 @@ module: utm_proxy_frontend
author: author:
- Johannes Brunswicker (@MatrixCrawler) - Johannes Brunswicker (@MatrixCrawler)
short_description: create, update or destroy reverse_proxy frontend entry in Sophos UTM short_description: Create, update or destroy reverse_proxy frontend entry in Sophos UTM
description: description:
- Create, update or destroy a reverse_proxy frontend entry in Sophos UTM. - Create, update or destroy a reverse_proxy frontend entry in Sophos UTM.

View file

@ -16,7 +16,7 @@ module: utm_proxy_frontend_info
author: author:
- Johannes Brunswicker (@MatrixCrawler) - Johannes Brunswicker (@MatrixCrawler)
short_description: create, update or destroy reverse_proxy frontend entry in Sophos UTM short_description: Create, update or destroy reverse_proxy frontend entry in Sophos UTM
description: description:
- Create, update or destroy a reverse_proxy frontend entry in SOPHOS UTM. - Create, update or destroy a reverse_proxy frontend entry in SOPHOS UTM.

View file

@ -16,7 +16,7 @@ module: utm_proxy_location
author: author:
- Johannes Brunswicker (@MatrixCrawler) - Johannes Brunswicker (@MatrixCrawler)
short_description: create, update or destroy reverse_proxy location entry in Sophos UTM short_description: Create, update or destroy reverse_proxy location entry in Sophos UTM
description: description:
- Create, update or destroy a reverse_proxy location entry in SOPHOS UTM. - Create, update or destroy a reverse_proxy location entry in SOPHOS UTM.

View file

@ -16,7 +16,7 @@ module: utm_proxy_location_info
author: author:
- Johannes Brunswicker (@MatrixCrawler) - Johannes Brunswicker (@MatrixCrawler)
short_description: create, update or destroy reverse_proxy location entry in Sophos UTM short_description: Create, update or destroy reverse_proxy location entry in Sophos UTM
description: description:
- Create, update or destroy a reverse_proxy location entry in SOPHOS UTM. - Create, update or destroy a reverse_proxy location entry in SOPHOS UTM.

View file

@ -11,7 +11,7 @@ __metaclass__ = type
DOCUMENTATION = ''' DOCUMENTATION = '''
--- ---
module: vertica_configuration module: vertica_configuration
short_description: Updates Vertica configuration parameters. short_description: Updates Vertica configuration parameters
description: description:
- Updates Vertica configuration parameters. - Updates Vertica configuration parameters.
options: options:

View file

@ -12,7 +12,7 @@ __metaclass__ = type
DOCUMENTATION = ''' DOCUMENTATION = '''
--- ---
module: vertica_info module: vertica_info
short_description: Gathers Vertica database facts. short_description: Gathers Vertica database facts
description: description:
- Gathers Vertica database information. - Gathers Vertica database information.
- This module was called C(vertica_facts) before Ansible 2.9, returning C(ansible_facts). - This module was called C(vertica_facts) before Ansible 2.9, returning C(ansible_facts).

View file

@ -12,7 +12,7 @@ __metaclass__ = type
DOCUMENTATION = ''' DOCUMENTATION = '''
--- ---
module: vertica_role module: vertica_role
short_description: Adds or removes Vertica database roles and assigns roles to them. short_description: Adds or removes Vertica database roles and assigns roles to them
description: description:
- Adds or removes Vertica database role and, optionally, assign other roles. - Adds or removes Vertica database role and, optionally, assign other roles.
options: options:

View file

@ -12,7 +12,7 @@ __metaclass__ = type
DOCUMENTATION = ''' DOCUMENTATION = '''
--- ---
module: vertica_schema module: vertica_schema
short_description: Adds or removes Vertica database schema and roles. short_description: Adds or removes Vertica database schema and roles
description: description:
- Adds or removes Vertica database schema and, optionally, roles - Adds or removes Vertica database schema and, optionally, roles
with schema access privileges. with schema access privileges.

View file

@ -11,7 +11,7 @@ __metaclass__ = type
DOCUMENTATION = ''' DOCUMENTATION = '''
--- ---
module: vertica_user module: vertica_user
short_description: Adds or removes Vertica database users and assigns roles. short_description: Adds or removes Vertica database users and assigns roles
description: description:
- Adds or removes Vertica database user and, optionally, assigns roles. - Adds or removes Vertica database user and, optionally, assigns roles.
- A user will not be removed until all the dependencies have been dropped. - A user will not be removed until all the dependencies have been dropped.

View file

@ -12,7 +12,7 @@ __metaclass__ = type
DOCUMENTATION = ''' DOCUMENTATION = '''
--- ---
module: vmadm module: vmadm
short_description: Manage SmartOS virtual machines and zones. short_description: Manage SmartOS virtual machines and zones
description: description:
- Manage SmartOS virtual machines through vmadm(1M). - Manage SmartOS virtual machines through vmadm(1M).
author: Jasper Lievisse Adriaanse (@jasperla) author: Jasper Lievisse Adriaanse (@jasperla)

View file

@ -12,7 +12,7 @@ __metaclass__ = type
DOCUMENTATION = ''' DOCUMENTATION = '''
--- ---
module: xenserver_facts module: xenserver_facts
short_description: get facts reported on xenserver short_description: Get facts reported on xenserver
description: description:
- Reads data out of XenAPI, can be used instead of multiple xe commands. - Reads data out of XenAPI, can be used instead of multiple xe commands.
author: author:

View file

@ -12,7 +12,7 @@ __metaclass__ = type
DOCUMENTATION = ''' DOCUMENTATION = '''
--- ---
module: zfs_facts module: zfs_facts
short_description: Gather facts about ZFS datasets. short_description: Gather facts about ZFS datasets
description: description:
- Gather facts from ZFS dataset properties. - Gather facts from ZFS dataset properties.
author: Adam Števko (@xen0l) author: Adam Števko (@xen0l)

View file

@ -12,7 +12,7 @@ __metaclass__ = type
DOCUMENTATION = ''' DOCUMENTATION = '''
--- ---
module: zpool_facts module: zpool_facts
short_description: Gather facts about ZFS pools. short_description: Gather facts about ZFS pools
description: description:
- Gather facts from ZFS pool properties. - Gather facts from ZFS pool properties.
author: Adam Števko (@xen0l) author: Adam Števko (@xen0l)