[PR #5766/317f79ff backport][stable-6] multiple scaleway modules: fix…

…ed markups in doc (#5827) multiple scaleway modules: fixed markups in doc (#5766) * multiple scaleway modules: fixed markups in doc * Update plugins/modules/scaleway_ip.py Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/modules/scaleway_volume.py Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/modules/scaleway_private_network.py Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/modules/scaleway_security_group.py Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/modules/scaleway_security_group_rule.py Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/modules/scaleway_sshkey.py Co-authored-by: Felix Fontein <felix@fontein.de> * further docs adjustments Co-authored-by: Felix Fontein <felix@fontein.de> (cherry picked from commit 317f79f) Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
ansible-collections · Jan 12, 2023 · 1da5f7d · 1da5f7d
1 parent 559c914
commit 1da5f7d
Show file tree

Hide file tree

Showing 12 changed files with 55 additions and 60 deletions.
diff --git a/plugins/modules/scaleway_compute_private_network.py b/plugins/modules/scaleway_compute_private_network.py
@@ -92,7 +92,7 @@
 RETURN = '''
 scaleway_compute_private_network:
     description: Information on the VPC.
-    returned: success when C(state=present)
+    returned: success when I(state=present)
     type: dict
     sample:
         {

diff --git a/plugins/modules/scaleway_database_backup.py b/plugins/modules/scaleway_database_backup.py
@@ -19,7 +19,7 @@
 version_added: 1.2.0
 author: Guillaume Rodriguez (@guillaume_ro_fr)
 description:
-    - This module manages database backups on Scaleway account U(https://developer.scaleway.com).
+    - "This module manages database backups on Scaleway account U(https://developer.scaleway.com)."
 extends_documentation_fragment:
     - community.general.scaleway
 options:
@@ -58,30 +58,30 @@
     description:
         - Name used to identify the database backup.
         - Required for C(present) state.
-        - Ignored when C(state=absent), C(state=exported) or C(state=restored).
+        - Ignored when I(state=absent), I(state=exported) or I(state=restored).
     type: str
     required: false
 
   database_name:
     description:
         - Name used to identify the database.
         - Required for C(present) and C(restored) states.
-        - Ignored when C(state=absent) or C(state=exported).
+        - Ignored when I(state=absent) or I(state=exported).
     type: str
     required: false
 
   instance_id:
     description:
         - UUID of the instance associated to the database backup.
         - Required for C(present) and C(restored) states.
-        - Ignored when C(state=absent) or C(state=exported).
+        - Ignored when I(state=absent) or I(state=exported).
     type: str
     required: false
 
   expires_at:
     description:
         - Expiration datetime of the database backup (ISO 8601 format).
-        - Ignored when C(state=absent), C(state=exported) or C(state=restored).
+        - Ignored when I(state=absent), I(state=exported) or I(state=restored).
     type: str
     required: false
 
@@ -139,7 +139,7 @@
 RETURN = '''
 metadata:
     description: Backup metadata.
-    returned: when C(state=present), C(state=exported) or C(state=restored)
+    returned: when I(state=present), I(state=exported) or I(state=restored)
     type: dict
     sample: {
         "metadata": {

diff --git a/plugins/modules/scaleway_image_info.py b/plugins/modules/scaleway_image_info.py
@@ -26,7 +26,7 @@
   region:
     type: str
     description:
-      - Scaleway compute zone
+      - Scaleway compute zone.
     required: true
     choices:
       - ams1

diff --git a/plugins/modules/scaleway_ip.py b/plugins/modules/scaleway_ip.py
@@ -88,8 +88,8 @@
 
 RETURN = '''
 data:
-    description: This is only present when C(state=present)
-    returned: when C(state=present)
+    description: This is only present when I(state=present).
+    returned: when I(state=present)
     type: dict
     sample: {
       "ips": [

diff --git a/plugins/modules/scaleway_lb.py b/plugins/modules/scaleway_lb.py
@@ -29,19 +29,19 @@
   name:
     type: str
     description:
-      - Name of the load-balancer
+      - Name of the load-balancer.
     required: true
 
   description:
     type: str
     description:
-      - Description of the load-balancer
+      - Description of the load-balancer.
     required: true
 
   organization_id:
     type: str
     description:
-      - Organization identifier
+      - Organization identifier.
     required: true
 
   state:
@@ -56,7 +56,7 @@
   region:
     type: str
     description:
-    - Scaleway zone
+    - Scaleway zone.
     required: true
     choices:
       - nl-ams
@@ -68,7 +68,7 @@
     elements: str
     default: []
     description:
-    - List of tags to apply to the load-balancer
+    - List of tags to apply to the load-balancer.
 
   wait:
     description:
@@ -79,14 +79,14 @@
   wait_timeout:
     type: int
     description:
-    - Time to wait for the load-balancer to reach the expected state
+    - Time to wait for the load-balancer to reach the expected state.
     required: false
     default: 300
 
   wait_sleep_time:
     type: int
     description:
-    - Time to wait before every attempt to check the state of the load-balancer
+    - Time to wait before every attempt to check the state of the load-balancer.
     required: false
     default: 3
 '''

diff --git a/plugins/modules/scaleway_organization_info.py b/plugins/modules/scaleway_organization_info.py
@@ -20,7 +20,7 @@
 options:
   api_url:
     description:
-      - Scaleway API URL
+      - Scaleway API URL.
     default: 'https://account.scaleway.com'
     aliases: ['base_url']
 extends_documentation_fragment:
@@ -42,7 +42,7 @@
 RETURN = r'''
 ---
 scaleway_organization_info:
-  description: Response from Scaleway API
+  description: Response from Scaleway API.
   returned: success
   type: list
   elements: dict

diff --git a/plugins/modules/scaleway_private_network.py b/plugins/modules/scaleway_private_network.py
@@ -18,8 +18,7 @@
 version_added: 4.5.0
 author: Pascal MANGIN (@pastral)
 description:
-    - This module manages private network on Scaleway account
-      (U(https://developer.scaleway.com)).
+    - "This module manages private network on Scaleway account (U(https://developer.scaleway.com))."
 extends_documentation_fragment:
 - community.general.scaleway
 
@@ -88,7 +87,7 @@
 RETURN = '''
 scaleway_private_network:
     description: Information on the VPC.
-    returned: success when C(state=present)
+    returned: success when I(state=present)
     type: dict
     sample:
         {

diff --git a/plugins/modules/scaleway_security_group.py b/plugins/modules/scaleway_security_group.py
@@ -18,8 +18,7 @@
 short_description: Scaleway Security Group management module
 author: Antoine Barbare (@abarbare)
 description:
-    - This module manages Security Group on Scaleway account
-      U(https://developer.scaleway.com).
+    - "This module manages Security Group on Scaleway account U(https://developer.scaleway.com)."
 extends_documentation_fragment:
 - community.general.scaleway
 
@@ -105,8 +104,8 @@
 
 RETURN = '''
 data:
-    description: This is only present when C(state=present)
-    returned: when C(state=present)
+    description: This is only present when I(state=present).
+    returned: when I(state=present)
     type: dict
     sample: {
         "scaleway_security_group": {

diff --git a/plugins/modules/scaleway_security_group_rule.py b/plugins/modules/scaleway_security_group_rule.py
@@ -18,8 +18,7 @@
 short_description: Scaleway Security Group Rule management module
 author: Antoine Barbare (@abarbare)
 description:
-  - This module manages Security Group Rule on Scaleway account
-    U(https://developer.scaleway.com)
+  - "This module manages Security Group Rule on Scaleway account U(https://developer.scaleway.com)."
 extends_documentation_fragment:
   - community.general.scaleway
 requirements:
@@ -53,7 +52,7 @@
   protocol:
     type: str
     description:
-      - Network protocol to use
+      - Network protocol to use.
     choices:
       - TCP
       - UDP
@@ -62,20 +61,20 @@
 
   port:
     description:
-      - Port related to the rule, null value for all the ports
+      - Port related to the rule, null value for all the ports.
     required: true
     type: int
 
   ip_range:
     type: str
     description:
-      - IPV4 CIDR notation to apply to the rule
+      - IPV4 CIDR notation to apply to the rule.
     default: 0.0.0.0/0
 
   direction:
     type: str
     description:
-      - Rule direction
+      - Rule direction.
     choices:
       - inbound
       - outbound
@@ -84,7 +83,7 @@
   action:
     type: str
     description:
-      - Rule action
+      - Rule action.
     choices:
       - accept
       - drop
@@ -93,7 +92,7 @@
   security_group:
     type: str
     description:
-      - Security Group unique identifier
+      - Security Group unique identifier.
     required: true
 '''
 
@@ -113,8 +112,8 @@
 
 RETURN = '''
 data:
-    description: This is only present when C(state=present)
-    returned: when C(state=present)
+    description: This is only present when I(state=present).
+    returned: when I(state=present)
     type: dict
     sample: {
         "scaleway_security_group_rule": {

diff --git a/plugins/modules/scaleway_sshkey.py b/plugins/modules/scaleway_sshkey.py
@@ -19,8 +19,7 @@
 short_description: Scaleway SSH keys management module
 author: Remy Leone (@remyleone)
 description:
-    - This module manages SSH keys on Scaleway account
-      U(https://developer.scaleway.com)
+    - "This module manages SSH keys on Scaleway account U(https://developer.scaleway.com)."
 extends_documentation_fragment:
 - community.general.scaleway
 
@@ -42,7 +41,7 @@
   api_url:
     type: str
     description:
-      - Scaleway API URL
+      - Scaleway API URL.
     default: 'https://account.scaleway.com'
     aliases: ['base_url']
 '''
@@ -67,8 +66,8 @@
 
 RETURN = '''
 data:
-    description: This is only present when C(state=present)
-    returned: when C(state=present)
+    description: This is only present when I(state=present).
+    returned: when I(state=present)
     type: dict
     sample: {
         "ssh_public_keys": [

diff --git a/plugins/modules/scaleway_user_data.py b/plugins/modules/scaleway_user_data.py
@@ -19,8 +19,8 @@
 short_description: Scaleway user_data management module
 author: Remy Leone (@remyleone)
 description:
-    - "This module manages user_data on compute instances on Scaleway."
-    - "It can be used to configure cloud-init for instance"
+    - This module manages user_data on compute instances on Scaleway.
+    - It can be used to configure cloud-init for instance.
 extends_documentation_fragment:
 - community.general.scaleway
 
@@ -30,20 +30,20 @@
   server_id:
     type: str
     description:
-    - Scaleway Compute instance ID of the server
+    - Scaleway Compute instance ID of the server.
     required: true
 
   user_data:
     type: dict
     description:
     - User defined data. Typically used with C(cloud-init).
-    - Pass your cloud-init script here as a string
+    - Pass your C(cloud-init) script here as a string.
     required: false
 
   region:
     type: str
     description:
-    - Scaleway compute zone
+    - Scaleway compute zone.
     required: true
     choices:
       - ams1