]> git.ipfire.org Git - thirdparty/dnspython.git/commitdiff
doco tweaks
authorBob Halley <halley@dnspython.org>
Wed, 20 May 2020 13:13:18 +0000 (06:13 -0700)
committerBob Halley <halley@dnspython.org>
Wed, 20 May 2020 13:13:18 +0000 (06:13 -0700)
doc/rdata-class.rst
doc/rdata.rst
doc/resolver-functions.rst

index fbe0004b04479b262e4ae78fdd22940032805832..723c706682960adf71e8ddae29219b5da2a72cbf 100644 (file)
@@ -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:
index 3ac42179c67457909163a842e4838df5d7eff928..13aa964bef4961d89152949db296aa964f3aeda0 100644 (file)
@@ -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
index 1fb432c6a5de22dd777bc71793fdabf0b88fea73..6e579571b00c6637705eb031ce5a687fbad7f7b1 100644 (file)
@@ -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