summaryrefslogtreecommitdiff
path: root/doc/message-class.rst
diff options
context:
space:
mode:
authorBob Halley <halley@dnspython.org>2017-01-14 10:22:45 -0800
committerBob Halley <halley@dnspython.org>2017-01-14 10:22:45 -0800
commitfc7db7da4284eedaa951e6acc34e6e6f94da1c64 (patch)
tree4b4c08c5b63246767be3bcd8746432589da19119 /doc/message-class.rst
parentcaee7d577bdb9675cf4a4015a480c3529a5d1140 (diff)
downloaddnspython-fc7db7da4284eedaa951e6acc34e6e6f94da1c64.tar.gz
Message doco.
Add constants to allow a section name to be specified symbolically rather than by passing the actual section list value.
Diffstat (limited to 'doc/message-class.rst')
-rw-r--r--doc/message-class.rst10
1 files changed, 9 insertions, 1 deletions
diff --git a/doc/message-class.rst b/doc/message-class.rst
index 6f6a98e..13e740e 100644
--- a/doc/message-class.rst
+++ b/doc/message-class.rst
@@ -66,7 +66,7 @@ The dns.message.Message Class
.. attribute:: keyalgorithm
- A ``text``, the TSIG algorithm to use. Defaults to
+ A ``dns.name.Name``, the TSIG algorithm to use. Defaults to
``dns.tsig.default_algorithm``. Constants for TSIG algorithms are
defined the in ``dns.tsig`` module.
@@ -137,3 +137,11 @@ The dns.message.Message Class
``(section, name, rdclass, rdtype, covers, deleting)``. The default
is ``{}``. Indexing improves the performance of finding RRsets.
Indexing can be disabled by setting the index to ``None``.
+
+The following constants may be used to specify sections in the
+``find_rrset()`` and ``get_rrset()`` methods:
+
+.. autodata:: dns.message.QUESTION
+.. autodata:: dns.message.ANSWER
+.. autodata:: dns.message.AUTHORITY
+.. autodata:: dns.message.ADDITIONAL