Skip to content

Commit

Permalink
Docs: sanity fixes (ansible-collections#133)
Browse files Browse the repository at this point in the history
Signed-off-by: Abhijeet Kasurde <[email protected]>
  • Loading branch information
Akasurde authored and jillr committed May 10, 2021
1 parent 3c3c32b commit 3e9f0b6
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 8 deletions.
11 changes: 7 additions & 4 deletions plugins/modules/ec2_instance.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
__metaclass__ = type


DOCUMENTATION = '''
DOCUMENTATION = r'''
---
module: ec2_instance
version_added: 1.0.0
Expand All @@ -25,6 +25,7 @@
description:
- If you specify one or more instance IDs, only instances that have the specified IDs are returned.
type: list
elements: str
state:
description:
- Goal state for the instances.
Expand Down Expand Up @@ -107,6 +108,7 @@
description:
- A list of security group IDs or names (strings). Mutually exclusive with I(security_group).
type: list
elements: str
security_group:
description:
- A security group ID or name. Mutually exclusive with I(security_groups).
Expand Down Expand Up @@ -180,6 +182,7 @@
ebs.iops, and ebs.delete_on_termination.
- For more information about each parameter, see U(https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_BlockDeviceMapping.html).
type: list
elements: dict
launch_template:
description:
- The EC2 launch template to base instance configuration on.
Expand Down Expand Up @@ -1681,7 +1684,7 @@ def main():
ebs_optimized=dict(type='bool'),
vpc_subnet_id=dict(type='str', aliases=['subnet_id']),
availability_zone=dict(type='str'),
security_groups=dict(default=[], type='list'),
security_groups=dict(default=[], type='list', elements='str'),
security_group=dict(type='str'),
instance_role=dict(type='str'),
name=dict(type='str'),
Expand All @@ -1700,9 +1703,9 @@ def main():
instance_initiated_shutdown_behavior=dict(type='str', choices=['stop', 'terminate']),
termination_protection=dict(type='bool'),
detailed_monitoring=dict(type='bool'),
instance_ids=dict(default=[], type='list'),
instance_ids=dict(default=[], type='list', elements='str'),
network=dict(default=None, type='dict'),
volumes=dict(default=None, type='list'),
volumes=dict(default=None, type='list', elements='dict'),
)
# running/present are synonyms
# as are terminated/absent
Expand Down
9 changes: 5 additions & 4 deletions plugins/modules/ec2_instance_info.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
__metaclass__ = type


DOCUMENTATION = '''
DOCUMENTATION = r'''
---
module: ec2_instance_info
version_added: 1.0.0
Expand All @@ -24,6 +24,7 @@
- If you specify one or more instance IDs, only instances that have the specified IDs are returned.
required: false
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
Expand All @@ -39,7 +40,7 @@
'''

EXAMPLES = '''
EXAMPLES = r'''
# Note: These examples do not set authentication details, see the AWS Guide for details.
- name: Gather information about all instances
Expand Down Expand Up @@ -67,7 +68,7 @@
'''

RETURN = '''
RETURN = r'''
instances:
description: a list of ec2 instances
returned: always
Expand Down Expand Up @@ -540,7 +541,7 @@ def main():
argument_spec = ec2_argument_spec()
argument_spec.update(
dict(
instance_ids=dict(default=[], type='list'),
instance_ids=dict(default=[], type='list', elements='str'),
filters=dict(default={}, type='dict')
)
)
Expand Down

0 comments on commit 3e9f0b6

Please sign in to comment.