[PR #5766/317f79ff backport][stable-6] multiple scaleway modules: fixed 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 317f79ff1f) Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
2024-09-14 20:13:21 +02:00 · 2023-01-12 21:56:31 +01:00 · 2023-01-12 21:56:31 +01:00 · 1da5f7dc54
commit 1da5f7dc54
parent 559c914e36
12 changed files with 55 additions and 60 deletions
--- a/plugins/modules/scaleway_compute_private_network.py
+++ b/plugins/modules/scaleway_compute_private_network.py
@ -92,7 +92,7 @@ EXAMPLES = '''
 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:
        {
--- a/plugins/modules/scaleway_database_backup.py
+++ b/plugins/modules/scaleway_database_backup.py
@ -19,7 +19,7 @@ short_description: Scaleway database backups management module
 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,7 +58,7 @@ options:
    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

@ -66,7 +66,7 @@ options:
    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

@ -74,14 +74,14 @@ options:
    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 @@ EXAMPLES = '''
 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": {
--- a/plugins/modules/scaleway_image_info.py
+++ b/plugins/modules/scaleway_image_info.py
@ -26,7 +26,7 @@ options:
  region:
    type: str
    description:
-      - Scaleway compute zone
+      - Scaleway compute zone.
    required: true
    choices:
      - ams1
--- a/plugins/modules/scaleway_ip.py
+++ b/plugins/modules/scaleway_ip.py
@ -88,8 +88,8 @@ EXAMPLES = '''

 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": [
--- a/plugins/modules/scaleway_lb.py
+++ b/plugins/modules/scaleway_lb.py
@ -29,19 +29,19 @@ options:
  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 @@ options:
  region:
    type: str
    description:
-    - Scaleway zone
+    - Scaleway zone.
    required: true
    choices:
      - nl-ams
@ -68,7 +68,7 @@ options:
    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 @@ options:
  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
 '''
--- a/plugins/modules/scaleway_organization_info.py
+++ b/plugins/modules/scaleway_organization_info.py
@ -20,7 +20,7 @@ author:
 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 @@ EXAMPLES = r'''
 RETURN = r'''
 ---
 scaleway_organization_info:
-  description: Response from Scaleway API
+  description: Response from Scaleway API.
  returned: success
  type: list
  elements: dict
--- a/plugins/modules/scaleway_private_network.py
+++ b/plugins/modules/scaleway_private_network.py
@ -18,8 +18,7 @@ short_description: Scaleway private network management
 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 @@ EXAMPLES = '''
 RETURN = '''
 scaleway_private_network:
    description: Information on the VPC.
-    returned: success when C(state=present)
+    returned: success when I(state=present)
    type: dict
    sample:
        {
--- a/plugins/modules/scaleway_security_group.py
+++ b/plugins/modules/scaleway_security_group.py
@ -18,8 +18,7 @@ module: scaleway_security_group
 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 @@ EXAMPLES = '''

 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": {
--- a/plugins/modules/scaleway_security_group_rule.py
+++ b/plugins/modules/scaleway_security_group_rule.py
@ -18,8 +18,7 @@ module: scaleway_security_group_rule
 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 @@ options:
  protocol:
    type: str
    description:
-      - Network protocol to use
+      - Network protocol to use.
    choices:
      - TCP
      - UDP
@ -62,20 +61,20 @@ options:

  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 @@ options:
  action:
    type: str
    description:
-      - Rule action
+      - Rule action.
    choices:
      - accept
      - drop
@ -93,7 +92,7 @@ options:
  security_group:
    type: str
    description:
-      - Security Group unique identifier
+      - Security Group unique identifier.
    required: true
 '''

@ -113,8 +112,8 @@ EXAMPLES = '''

 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": {
--- a/plugins/modules/scaleway_sshkey.py
+++ b/plugins/modules/scaleway_sshkey.py
@ -19,8 +19,7 @@ module: scaleway_sshkey
 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 @@ options:
  api_url:
    type: str
    description:
-      - Scaleway API URL
+      - Scaleway API URL.
    default: 'https://account.scaleway.com'
    aliases: ['base_url']
 '''
@ -67,8 +66,8 @@ EXAMPLES = '''

 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": [
--- a/plugins/modules/scaleway_user_data.py
+++ b/plugins/modules/scaleway_user_data.py
@ -19,8 +19,8 @@ module: scaleway_user_data
 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 @@ options:
  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
--- a/plugins/modules/scaleway_volume.py
+++ b/plugins/modules/scaleway_volume.py
@ -18,8 +18,7 @@ module: scaleway_volume
 short_description: Scaleway volumes management module
 author: Henryk Konsek (@hekonsek)
 description:
-    - This module manages volumes on Scaleway account
-      U(https://developer.scaleway.com)
+    - "This module manages volumes on Scaleway account U(https://developer.scaleway.com)."
 extends_documentation_fragment:
 - community.general.scaleway

@ -28,7 +27,7 @@ options:
  state:
    type: str
    description:
-     - Indicate desired state of the volume.
+      - Indicate desired state of the volume.
    default: present
    choices:
      - present
@ -36,7 +35,7 @@ options:
  region:
    type: str
    description:
-     - Scaleway region to use (for example par1).
+      - Scaleway region to use (for example par1).
    required: true
    choices:
      - ams1
@ -50,25 +49,25 @@ options:
  name:
    type: str
    description:
-     - Name used to identify the volume.
+      - Name used to identify the volume.
    required: true
  project:
    type: str
    description:
-     - Scaleway project ID to which volume belongs.
+      - Scaleway project ID to which volume belongs.
    version_added: 4.3.0
  organization:
    type: str
    description:
-     - ScaleWay organization ID to which volume belongs.
+      - ScaleWay organization ID to which volume belongs.
  size:
    type: int
    description:
-     - Size of the volume in bytes.
+      - Size of the volume in bytes.
  volume_type:
    type: str
    description:
-     - Type of the volume (for example 'l_ssd').
+      - Type of the volume (for example 'l_ssd').
 '''

 EXAMPLES = '''
@ -91,8 +90,8 @@ EXAMPLES = '''

 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: {
      "volume": {
@ -100,9 +99,9 @@ data:
        "id": "c675f420-cfeb-48ff-ba2a-9d2a4dbe3fcd",
        "name": "volume-0-3",
        "project": "000a115d-2852-4b0a-9ce8-47f1134ba95a",
-         "server": null,
-         "size": 10000000000,
-         "volume_type": "l_ssd"
+        "server": null,
+        "size": 10000000000,
+        "volume_type": "l_ssd"
  }
 }
 '''