]> git.ipfire.org Git - thirdparty/dnspython.git/commitdiff
start documenting rdata
authorBob Halley <halley@dnspython.org>
Sun, 1 Jan 2017 17:27:58 +0000 (09:27 -0800)
committerBob Halley <halley@dnspython.org>
Sun, 1 Jan 2017 17:27:58 +0000 (09:27 -0800)
doc/manual.rst
doc/rdata-types.rst [new file with mode: 0644]
doc/rdata.rst [new file with mode: 0644]

index 5bf893a4711200cf817ad0aaec22f5f555ea7c41..50b1afb33c26675b18670a23dfd29b76f972d966 100644 (file)
@@ -7,4 +7,4 @@ Dnspython Manual
 
    py2vs3
    name
-
+   rdata
diff --git a/doc/rdata-types.rst b/doc/rdata-types.rst
new file mode 100644 (file)
index 0000000..ba8ae41
--- /dev/null
@@ -0,0 +1,22 @@
+.. _rdata-types:
+
+Rdata classes and types
+-----------------------
+
+Sets of typed data can be associated with a given name.  A single typed
+datum is called an *rdata*.  The type of an rdata is specified by its
+*rdataclass* and *rdatatype*.  The class is almost always `IN`, the Internet
+class, and may often be omitted in the dnspython APIs.
+
+The ``dns.rdataclass`` module provides constants for each defined
+rdata class, as well as some helpful functions.  The ``dns.rdatatype``
+module does the same for rdata types.  Examples of the constants are::
+
+  dns.rdataclass.IN
+  dns.rdatatype.AAAA
+
+.. automodule:: dns.rdataclass
+   :members:
+  
+.. automodule:: dns.rdatatype
+   :members:
diff --git a/doc/rdata.rst b/doc/rdata.rst
new file mode 100644 (file)
index 0000000..367e9e6
--- /dev/null
@@ -0,0 +1,8 @@
+.. _rdata:
+
+DNS Rdata
+=========
+
+.. toctree::
+
+   rdata-types