]> git.ipfire.org Git - thirdparty/dnspython.git/commitdiff
Improve dns.message.make_query() docs.
authorBrian Wellington <bwelling@xbill.org>
Wed, 13 Oct 2021 23:31:03 +0000 (16:31 -0700)
committerBrian Wellington <bwelling@xbill.org>
Wed, 13 Oct 2021 23:32:46 +0000 (16:32 -0700)
Update the docs to match the code.  Specifically, the docs implied that
EDNS was only enabled if use_edns was set, while the code would enable
EDNS if any parameter that required EDNS was set and use_edns was not
set.

dns/message.py

index 6fa90ca5bf4ab79eec8cc43d4a6dd029f534450f..baa1116dd660243761f184b37fa236af76847a71 100644 (file)
@@ -1400,7 +1400,9 @@ def make_query(qname, rdtype, rdclass=dns.rdataclass.IN, use_edns=None,
     is class IN.
 
     *use_edns*, an ``int``, ``bool`` or ``None``.  The EDNS level to use; the
-    default is None (no EDNS).
+    default is ``None``.  If ``None``, EDNS will be enabled only if other
+    parameters (*ednsflags*, *payload*, *request_payload*, or *options*) are
+    set.
     See the description of dns.message.Message.use_edns() for the possible
     values for use_edns and their meanings.