diff options
| author | Bob Halley <halley@dnspython.org> | 2020-05-20 06:13:18 -0700 |
|---|---|---|
| committer | Bob Halley <halley@dnspython.org> | 2020-05-20 06:13:18 -0700 |
| commit | 020634c62c0417e257ec622665f910b7a2d46d27 (patch) | |
| tree | 59f74666262f835f5a101553e96d13301aa669d0 /doc | |
| parent | d48862f752653357919e520a8cd0bca6444a32d8 (diff) | |
| download | dnspython-020634c62c0417e257ec622665f910b7a2d46d27.tar.gz | |
doco tweaks
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/rdata-class.rst | 13 | ||||
| -rw-r--r-- | doc/rdata.rst | 8 | ||||
| -rw-r--r-- | doc/resolver-functions.rst | 3 |
3 files changed, 17 insertions, 7 deletions
diff --git a/doc/rdata-class.rst b/doc/rdata-class.rst index fbe0004..723c706 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 3ac4217..13aa964 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 1fb432c..6e57957 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 |