Rev 214: Added XMLRPC docstrings. in http://bzr.daniel-watkins.co.uk/pqm/xmlrpc

Daniel Watkins daniel at daniel-watkins.co.uk
Thu Aug 7 03:29:01 BST 2008


At http://bzr.daniel-watkins.co.uk/pqm/xmlrpc

------------------------------------------------------------
revno: 214
revision-id: daniel at daniel-watkins.co.uk-20080807022715-cs7xg9620ivyqka9
parent: daniel at daniel-watkins.co.uk-20080807021819-7b80l71d2ygpvrai
committer: Daniel Watkins <daniel at daniel-watkins.co.uk>
branch nick: xmlrpc
timestamp: Thu 2008-08-07 03:27:15 +0100
message:
  Added XMLRPC docstrings.
-------------- next part --------------
=== modified file 'pqm/ui/xmlrpc.py'
--- a/pqm/ui/xmlrpc.py	2008-08-01 00:43:22 +0000
+++ b/pqm/ui/xmlrpc.py	2008-08-07 02:27:15 +0000
@@ -29,13 +29,30 @@
 
 
 class PQM_XMLRPC(XMLRPC):
+    """An XMLRPC object for PQM submissions.
+
+    :ivar pqminfo: A PQMInfo object.
+    :ivar logger: The logger to which messages should be sent.
+    """
 
     def __init__(self, pqminfo):
+        """Construct a PQM_XMLRPC instance.
+
+        :param pqminfo: A PQMInfo object representing the PQM queue that
+            requests are to be submitted for.
+        """
         XMLRPC.__init__(self)
         self.pqminfo = pqminfo
         self.logger = logging.getLogger('pqm')
 
     def xmlrpc_submit(self, text):
+        """A method exposed via XMLRPC to submit items to the PQM queue.
+
+        :param text: The text of the submission email message to be added to
+            the queue.
+
+        :return: A string representing the success of the submission.
+        """
         try:
             queuedir = self.pqminfo.queuedir
             queuedir = os.path.abspath(queuedir)



More information about the bazaar-commits mailing list