Docs: sanity fixes (ansible-collections#133)

Signed-off-by: Abhijeet Kasurde <[email protected]> This commit was initially merged in https://github.com/ansible-collections/community.aws See: ansible-collections/community.aws@059cf9e
abikouo · Oct 15, 2024 · 7f5d7c8 · 7f5d7c8
1 parent 6c51c84
commit 7f5d7c8
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 10 deletions.
diff --git a/plugins/modules/ec2_vpc_nacl.py b/plugins/modules/ec2_vpc_nacl.py
@@ -6,7 +6,7 @@
 __metaclass__ = type
 
 
-DOCUMENTATION = '''
+DOCUMENTATION = r'''
 module: ec2_vpc_nacl
 short_description: create and delete Network ACLs.
 version_added: 1.0.0
@@ -39,6 +39,7 @@
       - Each subnet can be specified as subnet ID, or its tagged name.
     required: false
     type: list
+    elements: str
   egress:
     description:
       - A list of rules for outgoing traffic. Each rule must be specified as a list.
@@ -50,6 +51,7 @@
     default: []
     required: false
     type: list
+    elements: list
   ingress:
     description:
       - List of rules for incoming traffic. Each rule must be specified as a list.
@@ -61,6 +63,7 @@
     default: []
     required: false
     type: list
+    elements: list
   tags:
     description:
       - Dictionary of tags to look for and apply when creating a network ACL.
@@ -82,7 +85,7 @@
 requirements: [ botocore, boto3, json ]
 '''
 
-EXAMPLES = '''
+EXAMPLES = r'''
 
 # Complete example to create and delete a network ACL
 # that allows SSH, HTTP and ICMP in, and all traffic out.
@@ -138,7 +141,7 @@
     nacl_id: acl-33b4ee5b
     state: absent
 '''
-RETURN = '''
+RETURN = r'''
 task:
   description: The result of the create, or delete action.
   returned: success
@@ -602,10 +605,10 @@ def main():
         vpc_id=dict(),
         name=dict(),
         nacl_id=dict(),
-        subnets=dict(required=False, type='list', default=list()),
+        subnets=dict(required=False, type='list', default=list(), elements='str'),
         tags=dict(required=False, type='dict'),
-        ingress=dict(required=False, type='list', default=list()),
-        egress=dict(required=False, type='list', default=list()),
+        ingress=dict(required=False, type='list', default=list(), elements='list'),
+        egress=dict(required=False, type='list', default=list(), elements='list'),
         state=dict(default='present', choices=['present', 'absent']),
     )
     module = AnsibleAWSModule(argument_spec=argument_spec,

diff --git a/plugins/modules/ec2_vpc_nacl_info.py b/plugins/modules/ec2_vpc_nacl_info.py
@@ -5,7 +5,7 @@
 __metaclass__ = type
 
 
-DOCUMENTATION = '''
+DOCUMENTATION = r'''
 ---
 module: ec2_vpc_nacl_info
 version_added: 1.0.0
@@ -23,6 +23,7 @@
     default: []
     aliases: [nacl_id]
     type: list
+    elements: str
   filters:
     description:
       - A dict of filters to apply. Each dict item consists of a filter key and a filter value. See
@@ -40,7 +41,7 @@
 
 '''
 
-EXAMPLES = '''
+EXAMPLES = r'''
 # Note: These examples do not set authentication details, see the AWS Guide for details.
 
 # Gather information about all Network ACLs:
@@ -58,7 +59,7 @@
   register: default_nacls
 '''
 
-RETURN = '''
+RETURN = r'''
 nacls:
     description: Returns an array of complex objects as described below.
     returned: success
@@ -205,7 +206,7 @@ def nacl_entry_to_list(entry):
 def main():
 
     argument_spec = dict(
-        nacl_ids=dict(default=[], type='list', aliases=['nacl_id']),
+        nacl_ids=dict(default=[], type='list', aliases=['nacl_id'], elements='str'),
         filters=dict(default={}, type='dict'))
 
     module = AnsibleAWSModule(argument_spec=argument_spec, supports_check_mode=True)