summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorBob Halley <halley@dnspython.org>2020-05-09 13:50:16 -0700
committerBob Halley <halley@dnspython.org>2020-05-09 13:50:16 -0700
commit07e81b80e628d5b74580efb00c7caa93c6bd7b9f (patch)
tree8a95c2faf75f2213b268dd6806512efe47d9be49 /doc
parentd85b31d8be47bd7d8cfa67f7119ba833738a8038 (diff)
downloaddnspython-07e81b80e628d5b74580efb00c7caa93c6bd7b9f.tar.gz
binary -> bytes, text -> str
Diffstat (limited to 'doc')
-rw-r--r--doc/message-class.rst10
-rw-r--r--doc/name-class.rst2
-rw-r--r--doc/name.rst4
-rw-r--r--doc/resolver-class.rst6
4 files changed, 11 insertions, 11 deletions
diff --git a/doc/message-class.rst b/doc/message-class.rst
index 13e740e..a4ed049 100644
--- a/doc/message-class.rst
+++ b/doc/message-class.rst
@@ -58,7 +58,7 @@ The dns.message.Message Class
The TSIG keyring to use. The default is `None`. A TSIG keyring
is a dictionary mapping from TSIG key name, a ``dns.name.Name``, to
- a TSIG secret, a ``binary``.
+ a TSIG secret, a ``bytes``.
.. attribute:: keyname
@@ -72,7 +72,7 @@ The dns.message.Message Class
.. attribute:: request_mac
- A ``binary``, the TSIG MAC of the request message associated with
+ A ``bytes``, the TSIG MAC of the request message associated with
this message; used when validating TSIG signatures.
.. attribute:: fudge
@@ -89,12 +89,12 @@ The dns.message.Message Class
.. attribute:: other_data
- A ``binary``, the TSIG "other data". The default is the empty
- ``binary``.
+ A ``bytes``, the TSIG "other data". The default is the empty
+ ``bytes``.
.. attribute:: mac
- A ``binary``, the TSIG MAC for this message.
+ A ``bytes``, the TSIG MAC for this message.
.. attribute:: xfr
diff --git a/doc/name-class.rst b/doc/name-class.rst
index 4974446..35276ed 100644
--- a/doc/name-class.rst
+++ b/doc/name-class.rst
@@ -8,7 +8,7 @@ The dns.name.Name Class and Predefined Names
.. attribute:: labels
- A tuple of ``binary`` in DNS wire format specifying the DNS
+ A tuple of ``bytes`` in DNS wire format specifying the DNS
labels in the name, in order from least-signficiant label
(i.e. farthest from the origin) to most-significant label.
diff --git a/doc/name.rst b/doc/name.rst
index b1229a5..697ce3a 100644
--- a/doc/name.rst
+++ b/doc/name.rst
@@ -5,7 +5,7 @@ DNS Names
=========
Objects of the dns.name.Name class represent an immutable domain name.
-The representation is a tuple of labels, with each lable being a ``binary``
+The representation is a tuple of labels, with each lable being a ``bytes``
object in the DNS wire format. Typically names are not created by
supplying the labels tuple directly, but rather by converting from DNS
text format or the DNS wire format.
@@ -15,7 +15,7 @@ value for ``www.dnspython.org.`` is ``(b'www', b'dnspython', b'org', b'')`` on
Python 3, and ``('www', 'dnspython', 'org', '')`` on Python 2.
Names may be *absolute* or *relative*. Absolute names end in the root label,
-which is an empty ``binary``. Relative names do not end in the root label. To
+which is an empty ``bytes``. Relative names do not end in the root label. To
convert a relative name to an absolute name requires specifying an *origin*.
Typically the origin is known by context. Dnspython provides tools to
relativize and derelativize names. It's a good idea not to mix relative
diff --git a/doc/resolver-class.rst b/doc/resolver-class.rst
index 5d7df50..d0159a5 100644
--- a/doc/resolver-class.rst
+++ b/doc/resolver-class.rst
@@ -12,7 +12,7 @@ The dns.resolver.Resolver and dns.resolver.Answer Classes
.. attribute:: nameservers
- A ``list`` of ``text``, each item containing an IPv4 or IPv6 address.
+ A ``list`` of ``str``, each item containing an IPv4 or IPv6 address.
.. attribute:: search
@@ -27,7 +27,7 @@ The dns.resolver.Resolver and dns.resolver.Answer Classes
.. attribute:: nameserver_ports
- A ``dict`` mapping an IPv4 or IPv6 address ``text`` to an ``int``.
+ A ``dict`` mapping an IPv4 or IPv6 address ``str`` to an ``int``.
This specifies the port to use when sending to a nameserver. If
a port is not defined for an address, the value of the *port*
attribute will be used.
@@ -71,7 +71,7 @@ The dns.resolver.Resolver and dns.resolver.Answer Classes
.. attribute:: keyalgorithm
- A ``dns.name.Name`` or ``text``, the TSIG algorithm to use.
+ A ``dns.name.Name`` or ``str``, the TSIG algorithm to use.
*edns*, an ``int``, is the EDNS level to use. Specifying
``None``, ``False``, or ``-1`` means "do not use EDNS", and in
this case the other parameters are ignored. Specifying