added inline documentation for new dns methods

2 files changed, 24 insertions, 0 deletions

diff --git a/sleekxmpp/clientxmpp.py b/sleekxmpp/clientxmpp.py
index 2e81eb3b..170b35f0 100644
--- a/sleekxmpp/clientxmpp.py
+++ b/sleekxmpp/clientxmpp.py
@@ -141,6 +141,14 @@ class ClientXMPP(BaseXMPP):
                                  use_tls=use_tls, reattempt=reattempt)
 
     def get_dns_records(self, domain, port=None):
+        """
+        Get the DNS records for a domain.
+        Overridden XMLStream.get_dns_records to use SRV.
+
+        Arguments:
+            domain -- The domain in question.
+            port   -- If the results don't include a port, use this one.
+        """
         if port is None:
             port = self.default_port
         if DNSPYTHON:
diff --git a/sleekxmpp/xmlstream/xmlstream.py b/sleekxmpp/xmlstream/xmlstream.py
index 6c2c5aa5..ca8b5b6e 100644
--- a/sleekxmpp/xmlstream/xmlstream.py
+++ b/sleekxmpp/xmlstream/xmlstream.py
@@ -657,6 +657,13 @@ class XMLStream(object):
         return False
 
     def get_dns_records(self, domain, port=None):
+        """
+        Get the DNS records for a domain.
+
+        Arguments:
+            domain -- The domain in question.
+            port   -- If the results don't include a port, use this one.
+        """
         if port is None:
             port = self.default_port
         if DNSPYTHON:
@@ -673,6 +680,15 @@ class XMLStream(object):
             return [((domain, port), 0, 0)]
 
     def pick_dns_answer(self, domain, port=None):
+        """
+        Pick a server and port from DNS answers.
+        Gets DNS answers if none available.
+        Removes used answer from available answers.
+
+        Arguments:
+            domain -- The domain in question.
+            port   -- If the results don't include a port, use this one.
+        """
         if not self.dns_answers:
             self.dns_answers = self.get_dns_records(domain, port)
         addresses = {}