From: Bob Halley <halley@dnspython.org>
Date: Wed, 20 May 2020 13:13:18 +0000 (-0700)
Subject: doco tweaks
X-Git-Tag: v2.0.0rc1~184
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=020634c62c0417e257ec622665f910b7a2d46d27;p=thirdparty%2Fdnspython.git

doco tweaks
---

diff --git a/doc/rdata-class.rst b/doc/rdata-class.rst
index fbe0004b..723c7066 100644
--- a/doc/rdata-class.rst
+++ b/doc/rdata-class.rst
@@ -3,12 +3,13 @@
 DNS Rdata Base Class
 ====================
 
-All Rdata objects are instances of some subclass of ``dns.rdata.Rdata``.
-The Rdata factory functions described in :ref:`rdata-make` will create
-objects which are instances of the most appropriate subclass.  For example,
-a AAAA record will be an instance of the ``dns.rdtypes.IN.AAAA`` class,
-but a record of TYPE12345, which we don't know anything specific about,
-will be an instance of ``dns.rdata.GenericRdata``.
+All Rdata objects are instances of some subclass of
+``dns.rdata.Rdata``, and are immutable.  The Rdata factory functions
+described in :ref:`rdata-make` will create objects which are instances
+of the most appropriate subclass.  For example, a AAAA record will be
+an instance of the ``dns.rdtypes.IN.AAAA`` class, but a record of
+TYPE12345, which we don't know anything specific about, will be an
+instance of ``dns.rdata.GenericRdata``.
 
 .. autoclass:: dns.rdata.Rdata
    :members:
diff --git a/doc/rdata.rst b/doc/rdata.rst
index 3ac42179..13aa964b 100644
--- a/doc/rdata.rst
+++ b/doc/rdata.rst
@@ -3,6 +3,14 @@
 DNS Rdata
 =========
 
+An Rdata is typed data in one of the known DNS datatypes, for example
+type ``A``, the IPv4 address of a host or type ``MX``, how to route
+mail.  Unlike like the DNS RFC concept of RR, an Rdata is not bound to
+an owner name.  Rdata is immutable.
+
+Rdata of the same type can be grouped into an unnamed set, an
+Rdataset, or into a named set, an RRset.
+
 .. toctree::
 
    rdata-types
diff --git a/doc/resolver-functions.rst b/doc/resolver-functions.rst
index 1fb432c6..6e579571 100644
--- a/doc/resolver-functions.rst
+++ b/doc/resolver-functions.rst
@@ -4,8 +4,9 @@ Resolver Functions and The Default Resolver
 ===========================================
 
 .. autofunction:: dns.resolver.resolve
-.. autofunction:: dns.resolver.query
+.. autofunction:: dns.resolver.resolve_address
 .. autofunction:: dns.resolver.zone_for_name
+.. autofunction:: dns.resolver.query
 .. autodata:: dns.resolver.default_resolver
 .. autofunction:: dns.resolver.get_default_resolver
 .. autofunction:: dns.resolver.reset_default_resolver