]> git.ipfire.org Git - thirdparty/dnspython.git/commitdiff
minor doco edits
authorBob Halley <halley@dnspython.org>
Sat, 22 Aug 2020 19:43:24 +0000 (12:43 -0700)
committerBob Halley <halley@dnspython.org>
Sat, 22 Aug 2020 19:43:24 +0000 (12:43 -0700)
doc/inbound-xfr-class.rst
doc/name.rst
doc/query.rst
doc/zone-class.rst

index 73eaf572f659c5386a7b314ca453f1631c55967e..c5b747f9487f7d7e922820450e81241b9a6612d7 100644 (file)
@@ -3,11 +3,17 @@
 The dns.xfr.Inbound Class and make_query() function
 ---------------------------------------------------
 
-The ``Inbound`` class provides support for inbound DNS zone transfers, both
-AXFR and IXFR.  I/O is handled in other classes.  When a message related
-to the transfer arrives, the I/O code calls the ``process_message()`` method
+The ``Inbound`` class provides support for inbound DNS zone transfers,
+both AXFR and IXFR.  It is invoked by I/O code, i.e.
+:py:func:`dns.query.inbound_xfr` or
+:py:func:`dns.asyncquery.inbound_xfr`.  When a message related to the
+transfer arrives, the I/O code calls the ``process_message()`` method
 which adds the content to the pending transaction.
 
+The ``make_query()`` function is used to making the query message for
+the query methods to use in more complex situations, e.g. with TSIG or
+EDNS.
+
 .. autoclass:: dns.xfr.Inbound
    :members:
 
index d97c041a3032b0e95de10dcdd1a39a79caf33eb3..117691da480352364cad62390698664dd06e27e4 100644 (file)
@@ -29,9 +29,9 @@ order is the DNSSEC canonical ordering.  Relative names always sort before
 absolute names.
 
 Names may also be compared according to the DNS tree hierarchy with
-the ``fullcompare()`` method.  For example ```www.dnspython.org.`` is
-a subdomain of ``dnspython.org.``.  See the method description for
-full details.
+the :py:func:`dns.name.Name.fullcompare` method.  For example
+```www.dnspython.org.`` is a subdomain of ``dnspython.org.``.  See the
+method description for full details.
 
 .. toctree::
 
index beb086911eb20576889146bc1919e7bc9c8b886f..0fe3ccb6d29a353a55b005fc35a96d71dbf9489a 100644 (file)
@@ -41,8 +41,8 @@ HTTPS
 Zone Transfers
 --------------
 
-As of dnspython 2.1, ``dns.query.xfr`` is deprecated.  Please use
-``dns.query.inbound_xfr`` instead.
+As of dnspython 2.1, :py:func:`dns.query.xfr` is deprecated.  Please use
+:py:func:`dns.query.inbound_xfr` instead.
 
 .. autoclass:: dns.query.UDPMode
 
index 48e138e9d1044591c7f19a3dc39e6915dd04d56d..e77d90fe2be39179f9fad1d17f02640798091d67 100644 (file)
@@ -6,7 +6,7 @@ The dns.zone.Zone Class
 The ``Zone`` class provides a non-thread-safe implementation of a DNS zone,
 as well as a lightweight transation mechanism that allows it to be atomically
 updated.  For more complicated transactional needs, or for concurrency, please
-use the ``dns.versioned.Zone`` class (described below).
+use the :py:class:`dns.versioned.Zone` class (described below).
 
 .. autoclass:: dns.zone.Zone
    :members: