Use semantic markup.

Author: felixfontein

plugins/doc_fragments/hosttech.py

@@ -18,19 +18,19 @@ class ModuleDocFragment(object):
     hosttech_username:
         description:
           - The username for the Hosttech API user.
-          - If provided, I(hosttech_password) must also be provided.
-          - Mutually exclusive with I(hosttech_token).
+          - If provided, O(hosttech_password) must also be provided.
+          - Mutually exclusive with O(hosttech_token).
         type: str
     hosttech_password:
         description:
           - The password for the Hosttech API user.
-          - If provided, I(hosttech_password) must also be provided.
-          - Mutually exclusive with I(hosttech_token).
+          - If provided, O(hosttech_password) must also be provided.
+          - Mutually exclusive with O(hosttech_token).
         type: str
     hosttech_token:
         description:
           - The password for the Hosttech API user.
-          - Mutually exclusive with I(hosttech_username) and I(hosttech_password).
+          - Mutually exclusive with O(hosttech_username) and O(hosttech_password).
         type: str
         version_added: 0.2.0
 '''

plugins/doc_fragments/module_record.py

@@ -21,25 +21,25 @@ class ModuleDocFragment(object):
     zone:
         description:
           - The DNS zone to modify.
-          - Exactly one of I(zone) and I(zone_id) must be specified.
+          - Exactly one of O(zone) and O(zone_id) must be specified.
         type: str
     zone_id:
         description:
           - The ID of the DNS zone to modify.
-          - Exactly one of I(zone) and I(zone_id) must be specified.
+          - Exactly one of O(zone) and O(zone_id) must be specified.
         version_added: 0.2.0
     record:
         description:
           - The full DNS record to create or delete.
-          - Exactly one of I(record) and I(prefix) must be specified.
+          - Exactly one of O(record) and O(prefix) must be specified.
         type: str
     prefix:
         description:
           - The prefix of the DNS record.
-          - This is the part of I(record) before I(zone). For example, if the record to be modified is C(www.example.com)
-            for the zone C(example.com), the prefix is C(www). If the record in this example would be C(example.com), the
-            prefix would be C('') (empty string).
-          - Exactly one of I(record) and I(prefix) must be specified.
+          - This is the part of O(record) before O(zone). For example, if the record to be modified is V(www.example.com)
+            for the zone V(example.com), the prefix is V(www). If the record in this example would be V(example.com), the
+            prefix would be V('') (empty string).
+          - Exactly one of O(record) and O(prefix) must be specified.
         type: str
         version_added: 0.2.0
     ttl:
@@ -64,9 +64,9 @@ class ModuleDocFragment(object):
         elements: str
     overwrite:
         description:
-          - If I(state=present), whether an existing record should be overwritten on create if values do not
+          - If O(state=present), whether an existing record should be overwritten on create if values do not
             match.
-          - If I(state=absent), whether existing records should be deleted if values do not match.
+          - If O(state=absent), whether existing records should be deleted if values do not match.
         default: false
         type: bool
 

plugins/doc_fragments/module_record_info.py

@@ -23,31 +23,31 @@ class ModuleDocFragment(object):
     zone:
         description:
           - The DNS zone to modify.
-          - Exactly one of I(zone) and I(zone_id) must be specified.
+          - Exactly one of O(zone) and O(zone_id) must be specified.
         type: str
     zone_id:
         description:
           - The ID of the DNS zone to modify.
-          - Exactly one of I(zone) and I(zone_id) must be specified.
+          - Exactly one of O(zone) and O(zone_id) must be specified.
         version_added: 0.2.0
     record:
         description:
           - The full DNS record to retrieve.
-          - If I(what) is C(single_record) or C(all_types_for_record), exactly one of I(record) and I(prefix) is required.
+          - If O(what) is V(single_record) or V(all_types_for_record), exactly one of O(record) and O(prefix) is required.
         type: str
     prefix:
         description:
           - The prefix of the DNS record.
-          - This is the part of I(record) before I(zone). For example, if the record to be modified is C(www.example.com)
-            for the zone C(example.com), the prefix is C(www). If the record in this example would be C(example.com), the
-            prefix would be C('') (empty string).
-          - If I(what) is C(single_record) or C(all_types_for_record), exactly one of I(record) and I(prefix) is required.
+          - This is the part of O(record) before O(zone). For example, if the record to be modified is V(www.example.com)
+            for the zone V(example.com), the prefix is V(www). If the record in this example would be V(example.com), the
+            prefix would be V('') (empty string).
+          - If O(what) is V(single_record) or V(all_types_for_record), exactly one of O(record) and O(prefix) is required.
         type: str
         version_added: 0.2.0
     type:
         description:
           - The type of DNS record to retrieve.
-          - Required if I(what) is C(single_record).
+          - Required if O(what) is V(single_record).
         choices: ['A', 'CNAME', 'MX', 'AAAA', 'TXT', 'PTR', 'SRV', 'SPF', 'NS', 'CAA']
         type: str
 

plugins/doc_fragments/module_records.py

@@ -13,25 +13,25 @@ class ModuleDocFragment(object):
     DOCUMENTATION = r'''
 description:
     - The module allows to set, modify and delete multiple DNS records at once.
-    - With the I(purge) option, it is also possible to delete existing records
+    - With the O(purge) option, it is also possible to delete existing records
       that are not mentioned in the module parameters. With this, it is possible
       to synchronize the expected state of a DNS zone with the expected state.
-    - "It is possible to ignore certain records by specifying I(ignore: true) for
+    - "It is possible to ignore certain records by specifying O(ignore=true) for
        that record."
 
 options:
     zone:
         description:
           - The DNS zone to modify.
-          - Exactly one of I(zone) and I(zone_id) must be specified.
+          - Exactly one of O(zone) and O(zone_id) must be specified.
         type: str
     zone_id:
         description:
           - The ID of the DNS zone to modify.
-          - Exactly one of I(zone) and I(zone_id) must be specified.
+          - Exactly one of O(zone) and O(zone_id) must be specified.
     prune:
         description:
-          - If set to C(true), will remove all existing records in the zone that are not listed in I(records).
+          - If set to V(true), will remove all existing records in the zone that are not listed in O(records).
         type: bool
         default: false
     records:
@@ -44,15 +44,15 @@ class ModuleDocFragment(object):
             record:
                 description:
                   - The full DNS record to create or delete.
-                  - Exactly one of I(record) and I(prefix) must be specified.
+                  - Exactly one of O(record) and O(prefix) must be specified.
                 type: str
             prefix:
                 description:
                   - The prefix of the DNS record.
-                  - This is the part of I(record) before I(zone). For example, if the record to be modified is C(www.example.com)
-                    for the zone C(example.com), the prefix is C(www). If the record in this example would be C(example.com), the
-                    prefix would be C('') (empty string).
-                  - Exactly one of I(record) and I(prefix) must be specified.
+                  - This is the part of O(record) before O(zone). For example, if the record to be modified is V(www.example.com)
+                    for the zone V(example.com), the prefix is V(www). If the record in this example would be V(example.com), the
+                    prefix would be V('') (empty string).
+                  - Exactly one of O(record) and O(prefix) must be specified.
                 type: str
             ttl:
                 description:
@@ -71,13 +71,13 @@ class ModuleDocFragment(object):
                   - YAML lists or multiple comma-spaced values are allowed.
                   - When deleting a record all values for the record must be specified or it will
                     not be deleted.
-                  - Must be specified if I(ignore=false).
+                  - Must be specified if O(ignore=false).
                 type: list
                 elements: str
             ignore:
                 description:
-                  - If set to C(true), I(value) will be ignored.
-                  - This is useful when I(prune=true), but you do not want certain entries to be removed
+                  - If set to V(true), O(value) will be ignored.
+                  - This is useful when O(prune=true), but you do not want certain entries to be removed
                     without having to know their current value.
                 type: bool
                 default: false

plugins/doc_fragments/module_zone_info.py

@@ -15,12 +15,12 @@ class ModuleDocFragment(object):
     zone:
         description:
           - The DNS zone to modify.
-          - Exactly one of I(zone) and I(zone_id) must be specified.
+          - Exactly one of O(zone) and O(zone_id) must be specified.
         type: str
     zone_id:
         description:
           - The ID of the DNS zone to modify.
-          - Exactly one of I(zone) and I(zone_id) must be specified.
+          - Exactly one of O(zone) and O(zone_id) must be specified.
         version_added: 0.2.0
 
 notes:

plugins/modules/hosttech_dns_record_info.py

@@ -56,7 +56,7 @@
 set:
     description: The fetched record. Is empty if record does not exist.
     type: dict
-    returned: success and I(what) is C(single_record)
+    returned: success and O(what=single_record)
     contains:
         record:
             description: The record name.
@@ -94,7 +94,7 @@
     description: The list of fetched records.
     type: list
     elements: dict
-    returned: success and I(what) is not C(single_record)
+    returned: success and O(what=single_record)
     contains:
         record:
             description: The record name.

plugins/modules/wait_for_txt.py

@@ -27,7 +27,7 @@
         suboptions:
             name:
                 description:
-                    - A DNS name, like C(www.example.com).
+                    - A DNS name, like V(www.example.com).
                 type: str
                 required: true
             values:
@@ -38,17 +38,17 @@
                 required: true
             mode:
                 description:
-                    - Comparison modes for the values in I(values).
-                    - If C(subset), I(values) should be a (not necessarily proper) subset of the TXT values set for
+                    - Comparison modes for the values in O(values).
+                    - If V(subset), O(values) should be a (not necessarily proper) subset of the TXT values set for
                       the DNS name.
-                    - If C(superset), I(values) should be a (not necessarily proper) superset of the TXT values set
+                    - If V(superset), O(values) should be a (not necessarily proper) superset of the TXT values set
                       for the DNS name.
                       This includes the case that no TXT entries are set.
-                    - If C(superset_not_empty), I(values) should be a (not necessarily proper) superset of the TXT
+                    - If V(superset_not_empty), O(values) should be a (not necessarily proper) superset of the TXT
                       values set for the DNS name, assuming at least one TXT record is present.
-                    - If C(equals), I(values) should be the same set of strings as the TXT values for the DNS name
+                    - If V(equals), O(values) should be the same set of strings as the TXT values for the DNS name
                       (up to order).
-                    - If C(equals_ordered), I(values) should be the same ordered list of strings as the TXT values
+                    - If V(equals_ordered), O(values) should be the same ordered list of strings as the TXT values
                       for the DNS name.
                 type: str
                 default: subset
@@ -80,9 +80,9 @@
         default: 10
     always_ask_default_resolver:
         description:
-            - When set to C(true) (default), will use the default resolver to find the authoritative nameservers
+            - When set to V(true) (default), will use the default resolver to find the authoritative nameservers
               of a subzone.
-            - When set to C(false), will use the authoritative nameservers of the parent zone to find the
+            - When set to V(false), will use the authoritative nameservers of the parent zone to find the
               authoritative nameservers of a subzone. This only makes sense when the nameservers were recently
               changed and haven't propagated.
         type: bool
@@ -111,7 +111,7 @@
 records:
     description:
         - Results on the TXT records queried.
-        - The entries are in a 1:1 correspondence to the entries of the I(records) parameter,
+        - The entries are in a 1:1 correspondence to the entries of the O(records) parameter,
           in exactly the same order.
     returned: always
     type: list