Skip to content

Commit

Permalink
doco tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
rthalley committed May 20, 2020
1 parent d48862f commit 020634c
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 7 deletions.
13 changes: 7 additions & 6 deletions doc/rdata-class.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:
8 changes: 8 additions & 0 deletions doc/rdata.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 2 additions & 1 deletion doc/resolver-functions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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

0 comments on commit 020634c

Please sign in to comment.