diff options
| author | Bob Halley <halley@dnspython.org> | 2017-01-01 09:27:58 -0800 |
|---|---|---|
| committer | Bob Halley <halley@dnspython.org> | 2017-01-01 09:27:58 -0800 |
| commit | 83b659e71af755aeff634d0fa9dc5445fa21fa6c (patch) | |
| tree | fb9b9779efc5b1540c3ea2b04f38c28fdfcd2301 /doc | |
| parent | e1c3e9835229116ac93dc10d21d57ab73390ba2a (diff) | |
| download | dnspython-83b659e71af755aeff634d0fa9dc5445fa21fa6c.tar.gz | |
start documenting rdata
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/manual.rst | 2 | ||||
| -rw-r--r-- | doc/rdata-types.rst | 22 | ||||
| -rw-r--r-- | doc/rdata.rst | 8 |
3 files changed, 31 insertions, 1 deletions
diff --git a/doc/manual.rst b/doc/manual.rst index 5bf893a..50b1afb 100644 --- a/doc/manual.rst +++ b/doc/manual.rst @@ -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 index 0000000..ba8ae41 --- /dev/null +++ b/doc/rdata-types.rst @@ -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 index 0000000..367e9e6 --- /dev/null +++ b/doc/rdata.rst @@ -0,0 +1,8 @@ +.. _rdata: + +DNS Rdata +========= + +.. toctree:: + + rdata-types |