Use semantic markup.

felixfontein · felixfontein · commit 1f09d0982ee2 · 2021-07-12T22:14:54.000+02:00
diff --git a/plugins/doc_fragments/hetzner.py b/plugins/doc_fragments/hetzner.py
@@ -15,7 +15,7 @@ class ModuleDocFragment(object):
     hetzner_token:
         description:
           - The token for the Hetzner API.
-          - If not provided, will be read from the environment variable C(HETZNER_DNS_TOKEN).
+          - If not provided, will be read from the environment variable E(HETZNER_DNS_TOKEN).
         aliases:
           - api_token
         type: str
@@ -49,15 +49,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 C(www.example.com)
+                    for the zone C(example.com), the prefix is V(www). If the record in this example would be C(example.com), the
+                    prefix would be V('') (empty string).
+                  - Exactly one of O(record) and O(prefix) must be specified.
                 type: str
             ttl:
                 description:
@@ -70,13 +70,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
diff --git a/plugins/doc_fragments/hosttech.py b/plugins/doc_fragments/hosttech.py
@@ -18,20 +18,20 @@ 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).
-          - Since community.dns 1.2.0, the alias I(api_token) can be used.
+          - Mutually exclusive with O(hosttech_username) and O(hosttech_password).
+          - Since community.dns 1.2.0, the alias O(api_token) can be used.
         aliases:
           - api_token
         type: str
@@ -65,15 +65,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 C(www.example.com)
+                    for the zone C(example.com), the prefix is V(www). If the record in this example would be C(example.com), the
+                    prefix would be V('') (empty string).
+                  - Exactly one of O(record) and O(prefix) must be specified.
                 type: str
             ttl:
                 description:
@@ -86,13 +86,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
diff --git a/plugins/doc_fragments/module_record_info.py b/plugins/doc_fragments/module_record_info.py
@@ -23,33 +23,33 @@ class ModuleDocFragment(object):
     zone_name:
         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
         aliases:
           - zone
     zone_id:
         description:
           - The ID of the DNS zone to modify.
-          - Exactly one of I(zone_name) and I(zone_id) must be specified.
+          - Exactly one of O(zone_name) 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_name). 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_name). For example, if the record to be modified is C(www.example.com)
+            for the zone C(example.com), the prefix is V(www). If the record in this example would be C(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).
         type: str
 
 notes:
diff --git a/plugins/doc_fragments/module_record_set.py b/plugins/doc_fragments/module_record_set.py
@@ -21,33 +21,33 @@ class ModuleDocFragment(object):
     zone_name:
         description:
           - The DNS zone to modify.
-          - Exactly one of I(zone_name) and I(zone_id) must be specified.
+          - Exactly one of O(zone_name) and O(zone_id) must be specified.
         type: str
         aliases:
           - zone
     zone_id:
         description:
           - The ID of the DNS zone to modify.
-          - Exactly one of I(zone_name) and I(zone_id) must be specified.
+          - Exactly one of O(zone_name) 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_name). 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_name). For example, if the record to be modified is C(www.example.com)
+            for the zone C(example.com), the prefix is V(www). If the record in this example would be C(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:
         description:
           - The TTL to give the new record, in seconds.
-          - Will be ignored if I(state=absent) and I(on_existing=replace).
+          - Will be ignored if O(state=absent) and O(on_existing=replace).
         default: 3600
         type: int
     type:
@@ -61,22 +61,22 @@ 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(state=present) or when I(on_existing) is not C(replace).
-          - Will be ignored if I(state=absent) and I(on_existing=replace).
+          - Must be specified if O(state=present) or when O(on_existing) is not V(replace).
+          - Will be ignored if O(state=absent) and O(on_existing=replace).
         type: list
         elements: str
     on_existing:
         description:
           - This option defines the behavior if the record set already exists, but differs from the specified record set.
-            For this comparison, I(value) and I(ttl) are used for all records of type I(type) matching the I(prefix) resp. I(record).
-          - If set to C(replace), the record will be updated (I(state=present)) or removed (I(state=absent)).
-            This is the old I(overwrite=true) behavior.
-          - If set to C(keep_and_fail), the module will fail and not modify the records.
-            This is the old I(overwrite=false) behavior if I(state=present).
-          - If set to C(keep_and_warn), the module will warn and not modify the records.
-          - If set to C(keep), the module will not modify the records.
-            This is the old I(overwrite=false) behavior if I(state=absent).
-          - If I(state=absent) and the value is not C(replace), I(value) must be specified.
+            For this comparison, O(value) and O(ttl) are used for all records of type O(type) matching the O(prefix) resp. O(record).
+          - If set to V(replace), the record will be updated (O(state=present)) or removed (O(state=absent)).
+            This is the old O(overwrite=true) behavior.
+          - If set to V(keep_and_fail), the module will fail and not modify the records.
+            This is the old O(overwrite=false) behavior if O(state=present).
+          - If set to V(keep_and_warn), the module will warn and not modify the records.
+          - If set to V(keep), the module will not modify the records.
+            This is the old O(overwrite=false) behavior if O(state=absent).
+          - If O(state=absent) and the value is not V(replace), O(value) must be specified.
         default: replace
         type: str
         choices:
diff --git a/plugins/doc_fragments/module_record_sets.py b/plugins/doc_fragments/module_record_sets.py
@@ -13,27 +13,27 @@ class ModuleDocFragment(object):
     DOCUMENTATION = r'''
 description:
     - The module allows to set, modify and delete multiple DNS record sets at once.
-    - With the I(purge) option, it is also possible to delete existing record sets
+    - With the O(purge) option, it is also possible to delete existing record sets
       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 record sets by specifying I(ignore: true) for
+    - "It is possible to ignore certain record sets by specifying O(ignore: true) for
        that record set."
 
 options:
     zone_name:
         description:
           - The DNS zone to modify.
-          - Exactly one of I(zone_name) and I(zone_id) must be specified.
+          - Exactly one of O(zone_name) and O(zone_id) must be specified.
         type: str
         aliases:
           - zone
     zone_id:
         description:
           - The ID of the DNS zone to modify.
-          - Exactly one of I(zone_name) and I(zone_id) must be specified.
+          - Exactly one of O(zone_name) 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
     record_sets:
@@ -49,15 +49,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_name). 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_name). For example, if the record to be modified is C(www.example.com)
+                    for the zone C(example.com), the prefix is V(www). If the record in this example would be C(example.com), the
+                    prefix would be V('') (empty string).
+                  - Exactly one of O(record) and O(prefix) must be specified.
                 type: str
             ttl:
                 description:
@@ -75,13 +75,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
diff --git a/plugins/doc_fragments/module_zone_info.py b/plugins/doc_fragments/module_zone_info.py
@@ -15,14 +15,14 @@ class ModuleDocFragment(object):
     zone_name:
         description:
           - The DNS zone to query.
-          - Exactly one of I(zone_name) and I(zone_id) must be specified.
+          - Exactly one of O(zone_name) and O(zone_id) must be specified.
         type: str
         aliases:
           - zone
     zone_id:
         description:
           - The ID of the DNS zone to query.
-          - Exactly one of I(zone_name) and I(zone_id) must be specified.
+          - Exactly one of O(zone_name) and O(zone_id) must be specified.
         version_added: 0.2.0
 
 notes:
diff --git a/plugins/modules/hetzner_dns_record_info.py b/plugins/modules/hetzner_dns_record_info.py
@@ -54,7 +54,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) is V(single_record)
     contains:
         record:
             description: The record name.
@@ -92,7 +92,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) is not V(single_record)
     contains:
         record:
             description: The record name.
diff --git a/plugins/modules/hosttech_dns_record_info.py b/plugins/modules/hosttech_dns_record_info.py
@@ -54,7 +54,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.
@@ -92,7 +92,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.
diff --git a/plugins/modules/wait_for_txt.py b/plugins/modules/wait_for_txt.py
