From: Bob Halley <halley@dnspython.org>
Date: Sat, 22 Aug 2020 19:43:24 +0000 (-0700)
Subject: minor doco edits
X-Git-Tag: v2.1.0rc1~51
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=d1029c5e10f12b2e519ad55cd40c7beaa6805ae1;p=thirdparty%2Fdnspython.git

minor doco edits
---

diff --git a/doc/inbound-xfr-class.rst b/doc/inbound-xfr-class.rst
index 73eaf572..c5b747f9 100644
--- a/doc/inbound-xfr-class.rst
+++ b/doc/inbound-xfr-class.rst
@@ -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:
 
diff --git a/doc/name.rst b/doc/name.rst
index d97c041a..117691da 100644
--- a/doc/name.rst
+++ b/doc/name.rst
@@ -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::
 
diff --git a/doc/query.rst b/doc/query.rst
index beb08691..0fe3ccb6 100644
--- a/doc/query.rst
+++ b/doc/query.rst
@@ -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
 
diff --git a/doc/zone-class.rst b/doc/zone-class.rst
index 48e138e9..e77d90fe 100644
--- a/doc/zone-class.rst
+++ b/doc/zone-class.rst
@@ -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: