diff sat_pubsub/pgsql_storage.py @ 364:8bd8be6815ab

completed docstrings + use short notation for sets
author Arnaud Joset <info@agayon.be>
date Fri, 03 Nov 2017 13:59:54 +0100
parents 1167e48e5f52
children 9fbb31ce495b
line wrap: on
line diff
--- a/sat_pubsub/pgsql_storage.py	Fri Nov 03 13:59:15 2017 +0100
+++ b/sat_pubsub/pgsql_storage.py	Fri Nov 03 13:59:54 2017 +0100
@@ -83,8 +83,8 @@
 
     @param query: SQL query basis
     @param values: current values to replace in query
-    @param pep: True if we are in PEP mode
-    @param recipient: jid of the recipient
+    @param pep(bool): True if we are in PEP mode
+    @param recipient(jid.JID): jid of the recipient
     @return: query + PEP AND check,
         recipient's bare jid is added to value if needed
     """
@@ -213,6 +213,8 @@
     def getNodeIds(self, pep, recipient, allowed_accesses=None):
         """retrieve ids of existing nodes
 
+        @param pep(bool): True if it's a PEP request
+        @param recipient(jid.JID, None): recipient of the PEP request
         @param allowed_accesses(None, set): only nodes with access
             in this set will be returned
             None to return all nodes