diff options
| author | Bob Halley <halley@dnspython.org> | 2020-08-22 12:43:24 -0700 |
|---|---|---|
| committer | Bob Halley <halley@dnspython.org> | 2020-08-22 12:43:24 -0700 |
| commit | d1029c5e10f12b2e519ad55cd40c7beaa6805ae1 (patch) | |
| tree | d1894ada8827d7552d14c0c923a9523ee35768e8 /doc | |
| parent | 6fe02541577ef8113b60d1cadc49bd74efab0ff2 (diff) | |
| download | dnspython-d1029c5e10f12b2e519ad55cd40c7beaa6805ae1.tar.gz | |
minor doco edits
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/inbound-xfr-class.rst | 12 | ||||
| -rw-r--r-- | doc/name.rst | 6 | ||||
| -rw-r--r-- | doc/query.rst | 4 | ||||
| -rw-r--r-- | doc/zone-class.rst | 2 |
4 files changed, 15 insertions, 9 deletions
diff --git a/doc/inbound-xfr-class.rst b/doc/inbound-xfr-class.rst index 73eaf57..c5b747f 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 d97c041..117691d 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 beb0869..0fe3ccb 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 48e138e..e77d90f 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: |