From: Bob Halley <halley@nominum.com>
Date: Sun, 8 Apr 2012 13:22:51 +0000 (+0100)
Subject: doco fixes
X-Git-Tag: v1.10.0-py3~2
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=7b8e0117a91bab2fa536459e525d309bc445da77;p=thirdparty%2Fdnspython.git

doco fixes
---

diff --git a/dns/e164.py b/dns/e164.py
index cbb13388..3a14fd1d 100644
--- a/dns/e164.py
+++ b/dns/e164.py
@@ -32,7 +32,7 @@ def from_e164(text, origin=public_enum_domain):
     @type text: str
     @param origin: The domain in which the number should be constructed.
     The default is e164.arpa.
-    @type: dns.name.Name object or None
+    @type origin: dns.name.Name object or None
     @rtype: dns.name.Name object
     """
     parts = [d for d in text if d.isdigit()]
@@ -45,7 +45,7 @@ def to_e164(name, origin=public_enum_domain, want_plus_prefix=True):
     @type name: dns.name.Name object.
     @param origin: A domain containing the ENUM domain name.  The
     name is relativized to this domain before being converted to text.
-    @type: dns.name.Name object or None
+    @type origin: dns.name.Name object or None
     @param want_plus_prefix: if True, add a '+' to the beginning of the
     returned number.
     @rtype: str
diff --git a/dns/edns.py b/dns/edns.py
index ef52776e..f0e1c53d 100644
--- a/dns/edns.py
+++ b/dns/edns.py
@@ -23,8 +23,8 @@ class Option(object):
 
     def __init__(self, otype):
         """Initialize an option.
-        @param rdtype: The rdata type
-        @type rdtype: int
+        @param otype: The rdata type
+        @type otype: int
         """
         self.otype = otype
 
diff --git a/dns/ipv4.py b/dns/ipv4.py
index f3b6c5c5..d2f77037 100644
--- a/dns/ipv4.py
+++ b/dns/ipv4.py
@@ -20,11 +20,23 @@ import struct
 import dns.exception
 
 def inet_ntoa(address):
+    """Convert an IPv4 address in network form to text form.
+
+    @param address: The IPv4 address
+    @type address: bytes
+    @returns: string
+    """
     if len(address) != 4:
         raise dns.exception.SyntaxError
     return '%u.%u.%u.%u' % (address[0], address[1], address[2], address[3])
 
 def inet_aton(text):
+    """Convert an IPv4 address in text form to network form.
+
+    @param text: The IPv4 address
+    @type text: string
+    @returns: bytes
+    """
     parts = text.split('.')
     if len(parts) != 4:
         raise dns.exception.SyntaxError
diff --git a/dns/ipv6.py b/dns/ipv6.py
index e2bcecd1..17d43a39 100644
--- a/dns/ipv6.py
+++ b/dns/ipv6.py
@@ -25,7 +25,7 @@ def inet_ntoa(address):
     """Convert a network format IPv6 address into text.
 
     @param address: the binary address
-    @type address: string
+    @type address: bytes
     @rtype: string
     @raises ValueError: the address isn't 16 bytes long
     """
@@ -93,7 +93,7 @@ def inet_aton(text):
 
     @param text: the textual address
     @type text: string
-    @rtype: string
+    @rtype: bytes
     @raises dns.exception.SyntaxError: the text was not properly formatted
     """
 
diff --git a/dns/query.py b/dns/query.py
index 0e6eb929..2148df0f 100644
--- a/dns/query.py
+++ b/dns/query.py
@@ -46,12 +46,15 @@ def _compute_expiration(timeout):
         return time.time() + timeout
 
 def _poll_for(fd, readable, writable, error, timeout):
-    """
-    @param fd: File descriptor (int).
-    @param readable: Whether to wait for readability (bool).
-    @param writable: Whether to wait for writability (bool).
-    @param expiration: Deadline timeout (expiration time, in seconds (float)).
-
+    """Poll polling backend.
+    @param fd: File descriptor
+    @type fd: int
+    @param readable: Whether to wait for readability
+    @type readable: bool
+    @param writable: Whether to wait for writability
+    @type writable: bool
+    @param timeout: Deadline timeout (expiration time, in seconds)
+    @type timeout: float
     @return True on success, False on timeout
     """
     event_mask = 0
@@ -73,12 +76,15 @@ def _poll_for(fd, readable, writable, error, timeout):
     return bool(event_list)
 
 def _select_for(fd, readable, writable, error, timeout):
-    """
-    @param fd: File descriptor (int).
-    @param readable: Whether to wait for readability (bool).
-    @param writable: Whether to wait for writability (bool).
-    @param expiration: Deadline timeout (expiration time, in seconds (float)).
-
+    """Select polling backend.
+    @param fd: File descriptor
+    @type fd: int
+    @param readable: Whether to wait for readability
+    @type readable: bool
+    @param writable: Whether to wait for writability
+    @type writable: bool
+    @param timeout: Deadline timeout (expiration time, in seconds)
+    @type timeout: float
     @return True on success, False on timeout
     """
     rset, wset, xset = [], [], []
diff --git a/dns/resolver.py b/dns/resolver.py
index 4fb13d36..d2c7a6a0 100644
--- a/dns/resolver.py
+++ b/dns/resolver.py
@@ -315,8 +315,7 @@ class LRUCache(object):
     def __init__(self, max_size=100000):
         """Initialize a DNS cache.
 
-        @param max_size: The maximum number of nodes to cache; the default is
-        100000.  Must be > 1.
+        @param max_size: The maximum number of nodes to cache; the default is 100000.  Must be > 1.
         @type max_size: int
         """
         self.data = {}
diff --git a/dns/tokenizer.py b/dns/tokenizer.py
index 77636a23..adac5e29 100644
--- a/dns/tokenizer.py
+++ b/dns/tokenizer.py
@@ -54,9 +54,9 @@ class Token(object):
 
         @param ttype: The token type
         @type ttype: int
-        @ivar value: The token value
+        @param value: The token value
         @type value: string
-        @ivar has_escape: Does the token value contain escapes?
+        @param has_escape: Does the token value contain escapes?
         @type has_escape: bool
         """
         self.ttype = ttype