Fix Ansible documentation in part of example formatting. Part 1 (#332)

* Fix Ansible documentation in part of example formatting

* Fix

plugins/modules/cloud/google/gcdns_record.py

@@ -128,46 +128,46 @@ notes:
 '''
 
 EXAMPLES = '''
-# Create an A record.
-- gcdns_record:
+- name: Create an A record
+  gcdns_record:
     record: 'www1.example.com'
     zone: 'example.com'
     type: A
     value: '1.2.3.4'
 
-# Update an existing record.
-- gcdns_record:
+- name: Update an existing record
+  gcdns_record:
     record: 'www1.example.com'
     zone: 'example.com'
     type: A
     overwrite: true
     value: '5.6.7.8'
 
-# Remove an A record.
-- gcdns_record:
+- name: Remove an A record
+  gcdns_record:
     record: 'www1.example.com'
     zone_id: 'example-com'
     state: absent
     type: A
     value: '5.6.7.8'
 
-# Create a CNAME record.
-- gcdns_record:
+- name: Create a CNAME record. Note the trailing dot of value
+  gcdns_record:
     record: 'www.example.com'
     zone_id: 'example-com'
     type: CNAME
-    value: 'www.example.com.'    # Note the trailing dot
+    value: 'www.example.com.'
 
-# Create an MX record with a custom TTL.
-- gcdns_record:
+- name: Create an MX record with a custom TTL. Note the trailing dot of value
+  gcdns_record:
     record: 'example.com'
     zone: 'example.com'
     type: MX
     ttl: 3600
-    value: '10 mail.example.com.'    # Note the trailing dot
+    value: '10 mail.example.com.'
 
-# Create multiple A records with the same name.
-- gcdns_record:
+- name: Create multiple A records with the same name
+  gcdns_record:
     record: 'api.example.com'
     zone_id: 'example-com'
     type: A
@@ -177,54 +177,54 @@ EXAMPLES = '''
       - '198.51.100.5'
       - '203.0.113.10'
 
-# Change the value of an existing record with multiple record_data.
-- gcdns_record:
+- name: Change the value of an existing record with multiple record_data
+  gcdns_record:
     record: 'api.example.com'
     zone: 'example.com'
     type: A
     overwrite: true
-    record_data:           # WARNING: All values in a record will be replaced
+    record_data:        # WARNING: All values in a record will be replaced
       - '192.0.2.23'
       - '192.0.2.42'    # The changed record
       - '198.51.100.5'
       - '203.0.113.10'
 
-# Safely remove a multi-line record.
-- gcdns_record:
+- name: Safely remove a multi-line record
+  gcdns_record:
     record: 'api.example.com'
     zone_id: 'example-com'
     state: absent
     type: A
-    record_data:           # NOTE: All of the values must match exactly
+    record_data:        # NOTE: All of the values must match exactly
       - '192.0.2.23'
       - '192.0.2.42'
       - '198.51.100.5'
       - '203.0.113.10'
 
-# Unconditionally remove a record.
-- gcdns_record:
+- name: Unconditionally remove a record
+  gcdns_record:
     record: 'api.example.com'
     zone_id: 'example-com'
     state: absent
     overwrite: true   # overwrite is true, so no values are needed
     type: A
 
-# Create an AAAA record
-- gcdns_record:
+- name: Create an AAAA record
+  gcdns_record:
     record: 'www1.example.com'
     zone: 'example.com'
     type: AAAA
     value: 'fd00:db8::1'
 
-# Create a PTR record
-- gcdns_record:
+- name: Create a PTR record
+  gcdns_record:
     record: '10.5.168.192.in-addr.arpa'
     zone: '5.168.192.in-addr.arpa'
     type: PTR
     value: 'api.example.com.'    # Note the trailing dot.
 
-# Create an NS record
-- gcdns_record:
+- name: Create an NS record
+  gcdns_record:
     record: 'subdomain.example.com'
     zone: 'example.com'
     type: NS
@@ -235,8 +235,8 @@ EXAMPLES = '''
       - 'ns-cloud-d3.googledomains.com.'
       - 'ns-cloud-d4.googledomains.com.'
 
-# Create a TXT record
-- gcdns_record:
+- name: Create a TXT record
+  gcdns_record:
     record: 'example.com'
     zone_id: 'example-com'
     type: TXT

plugins/modules/cloud/google/gce_eip.py

@@ -36,8 +36,8 @@ options:
 '''
 
 EXAMPLES = '''
-# Create a Global external IP address
-- gce_eip:
+- name: Create a Global external IP address
+  gce_eip:
     service_account_email: "{{ service_account_email }}"
     credentials_file: "{{ credentials_file }}"
     project_id: "{{ project_id }}"
@@ -45,8 +45,8 @@ EXAMPLES = '''
     region: global
     state: present
 
-# Create a Regional external IP address
-- gce_eip:
+- name: Create a Regional external IP address
+  gce_eip:
     service_account_email: "{{ service_account_email }}"
     credentials_file: "{{ credentials_file }}"
     project_id: "{{ project_id }}"

plugins/modules/cloud/google/gce_img.py

@@ -59,25 +59,25 @@ author: "Tom Melendez (@supertom)"
 '''
 
 EXAMPLES = '''
-# Create an image named test-image from the disk 'test-disk' in zone us-central1-a.
-- gce_img:
+- name: Create an image named test-image from the disk 'test-disk' in zone us-central1-a
+  gce_img:
     name: test-image
     source: test-disk
     zone: us-central1-a
     state: present
 
-# Create an image named test-image from a tarball in Google Cloud Storage.
-- gce_img:
+- name: Create an image named test-image from a tarball in Google Cloud Storage
+  gce_img:
     name: test-image
     source: https://storage.googleapis.com/bucket/path/to/image.tgz
 
-# Alternatively use the gs scheme
-- gce_img:
+- name: Alternatively use the gs scheme
+  gce_img:
     name: test-image
     source: gs://bucket/path/to/image.tgz
 
-# Delete an image named test-image.
-- gce_img:
+- name: Delete an image named test-image
+  gce_img:
     name: test-image
     state: absent
 '''

plugins/modules/cloud/google/gce_lb.py

@@ -99,8 +99,8 @@ author: "Eric Johnson (@erjohnso) <erjohnso@google.com>"
 '''
 
 EXAMPLES = '''
-# Simple example of creating a new LB, adding members, and a health check
-- local_action:
+- name: Simple example of creating a new LB, adding members, and a health check
+  local_action:
     module: gce_lb
     name: testlb
     region: us-central1

plugins/modules/cloud/google/gce_pd.py

@@ -84,8 +84,8 @@ author: "Eric Johnson (@erjohnso) <erjohnso@google.com>"
 '''
 
 EXAMPLES = '''
-# Simple attachment action to an existing instance
-- local_action:
+- name: Simple attachment action to an existing instance
+  local_action:
     module: gce_pd
     instance_name: notlocalhost
     size_gb: 5

plugins/modules/cloud/google/gcpubsub_info.py

@@ -39,18 +39,18 @@ options:
 '''
 
 EXAMPLES = '''
-## List all Topics in a project
-- gcpubsub_info:
+- name: List all Topics in a project
+  gcpubsub_info:
     view: topics
     state: list
 
-## List all Subscriptions in a project
-- gcpubsub_info:
+- name: List all Subscriptions in a project
+  gcpubsub_info:
     view: subscriptions
     state: list
 
-## List all Subscriptions for a Topic in a project
-- gcpubsub_info:
+- name: List all Subscriptions for a Topic in a project
+  gcpubsub_info:
     view: subscriptions
     topic: my-topic
     state: list