From 651065bc03b72aefc66e2a475ff086a0c6b2f22e Mon Sep 17 00:00:00 2001 From: Toshio Kuratomi Date: Wed, 20 May 2020 10:43:22 -0700 Subject: [PATCH] Fix the docs for dig and nios. The return docs for both of these didn't follow what the docs build would understand. Changed them so that they are properly formatted. --- plugins/lookup/dig.py | 90 +++++++++++++++++++++++++++++++----------- plugins/lookup/nios.py | 5 ++- 2 files changed, 70 insertions(+), 25 deletions(-) diff --git a/plugins/lookup/dig.py b/plugins/lookup/dig.py index 29c2563903..5a25fe7e46 100644 --- a/plugins/lookup/dig.py +++ b/plugins/lookup/dig.py @@ -70,29 +70,73 @@ RETURN = """ description: - list of composed strings or dictonaries with key and value If a dictionary, fields shows the keys returned depending on query type - fields: - ALL: owner, ttl, type - A: address - AAAA: address - CNAME: target - DNAME: target - DLV: algorithm, digest_type, key_tag, digest - DNSKEY: flags, algorithm, protocol, key - DS: algorithm, digest_type, key_tag, digest - HINFO: cpu, os - LOC: latitude, longitude, altitude, size, horizontal_precision, vertical_precision - MX: preference, exchange - NAPTR: order, preference, flags, service, regexp, replacement - NS: target - NSEC3PARAM: algorithm, flags, iterations, salt - PTR: target - RP: mbox, txt - SOA: mname, rname, serial, refresh, retry, expire, minimum - SPF: strings - SRV: priority, weight, port, target - SSHFP: algorithm, fp_type, fingerprint - TLSA: usage, selector, mtype, cert - TXT: strings + contains: + ALL: + description: + - owner, ttl, type + A: + description: + - address + AAAA: + description: + - address + CNAME: + description: + - target + DNAME: + description: + - target + DLV: + description: + - algorithm, digest_type, key_tag, digest + DNSKEY: + description: + - flags, algorithm, protocol, key + DS: + description: + - algorithm, digest_type, key_tag, digest + HINFO: + description: + - cpu, os + LOC: + description: + - latitude, longitude, altitude, size, horizontal_precision, vertical_precision + MX: + description: + - preference, exchange + NAPTR: + description: + - order, preference, flags, service, regexp, replacement + NS: + description: + - target + NSEC3PARAM: + description: + - algorithm, flags, iterations, salt + PTR: + description: + - target + RP: + description: + - mbox, txt + SOA: + description: + - mname, rname, serial, refresh, retry, expire, minimum + SPF: + description: + - strings + SRV: + description: + - priority, weight, port, target + SSHFP: + description: + - algorithm, fp_type, fingerprint + TLSA: + description: + - usage, selector, mtype, cert + TXT: + description: + - strings """ from ansible.errors import AnsibleError diff --git a/plugins/lookup/nios.py b/plugins/lookup/nios.py index 8848e8cd1a..f5ba195010 100644 --- a/plugins/lookup/nios.py +++ b/plugins/lookup/nios.py @@ -85,8 +85,9 @@ obj_type: type: complex contains: obj_field: - - One or more obj_type fields as specified by return_fields argument or - the default set of fields as per the object type + description: + - One or more obj_type fields as specified by return_fields argument or + the default set of fields as per the object type """ from ansible.plugins.lookup import LookupBase