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]>

This commit was initially merged in https://github.com/ansible-collections/community.aws
See: ansible-collections@059cf9e
  • Loading branch information
Akasurde authored and goneri committed Sep 21, 2022
1 parent c8e9bf9 commit f9f8994
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 6 deletions.
7 changes: 4 additions & 3 deletions plugins/modules/route53.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
__metaclass__ = type


DOCUMENTATION = '''
DOCUMENTATION = r'''
---
module: route53
version_added: 1.0.0
Expand Down Expand Up @@ -69,6 +69,7 @@
- The new value when creating a DNS record. YAML lists or multiple comma-spaced values are allowed for non-alias records.
- When deleting a record all values for the record must be specified or Route53 will not delete it.
type: list
elements: str
overwrite:
description:
- Whether an existing record should be overwritten on create if values do not match.
Expand Down Expand Up @@ -137,7 +138,7 @@
'''

RETURN = '''
RETURN = r'''
nameservers:
description: Nameservers associated with the zone.
returned: when state is 'get'
Expand Down Expand Up @@ -501,7 +502,7 @@ def main():
alias=dict(type='bool'),
alias_hosted_zone_id=dict(type='str'),
alias_evaluate_target_health=dict(type='bool', default=False),
value=dict(type='list'),
value=dict(type='list', elements='str'),
overwrite=dict(type='bool'),
retry_interval=dict(type='int', default=500),
private_zone=dict(type='bool', default=False),
Expand Down
6 changes: 3 additions & 3 deletions plugins/modules/route53_info.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
__metaclass__ = type


DOCUMENTATION = '''
DOCUMENTATION = r'''
module: route53_info
short_description: Retrieves route53 details using AWS methods
version_added: 1.0.0
Expand Down Expand Up @@ -134,7 +134,7 @@
'''

EXAMPLES = '''
EXAMPLES = r'''
# Simple example of listing all hosted zones
- name: List all hosted zones
community.aws.route53_info:
Expand Down Expand Up @@ -436,7 +436,7 @@ def main():
'A', 'CNAME', 'MX', 'AAAA', 'TXT', 'PTR', 'SRV', 'SPF', 'CAA', 'NS'
]),
dns_name=dict(),
resource_id=dict(type='list', aliases=['resource_ids']),
resource_id=dict(type='list', aliases=['resource_ids'], elements='str'),
health_check_id=dict(),
hosted_zone_method=dict(choices=[
'details',
Expand Down

0 comments on commit f9f8994

Please sign in to comment.