A few more documentation fixes.

[quix0rs-apt-p2p.git] / apt_dht / interfaces.py

diff --git a/apt_dht/interfaces.py b/apt_dht/interfaces.py
index c6bea9d50b49b8e808c3be93cfacdf8a2a5d1cb1..2c022c5a7d65e6f4b5bf2872bdc23b575c1de76a 100644 (file)
--- a/apt_dht/interfaces.py
+++ b/apt_dht/interfaces.py
@@ -1,39 +1,43 @@
 
-"""
-Some interfaces that are used by the apt-dht classes.
-
-"""
+"""Some interfaces that are used by the apt-dht classes."""
 
 from zope.interface import Interface
 
 class IDHT(Interface):
     """An abstract interface for using a DHT implementation."""
     
-    def loadConfig(self, config):
+    def loadConfig(self, config, section):
         """Load the DHTs configuration from a dictionary.
         
-        @type config: C{dictionary}
+        @type config: C{SafeConfigParser}
         @param config: the dictionary of config values
         """
     
-    def join(self, bootstrap_nodes):
+    def join(self):
         """Bootstrap the new DHT node into the DHT.
         
-        @type bootstrap_nodes: C{list} of (C{string}, C{int})
-        @param bootstrap_nodes: a list of the nodes to contact to join the DHT
-        @rtype: C{Deffered}
+        @rtype: C{Deferred}
         @return: a deferred that will fire when the node has joined
         """
         
     def leave(self):
         """Depart gracefully from the DHT.
         
-        @rtype: C{Deffered}
-        @return: a deferred that will fire when the node has joined
+        @rtype: C{Deferred}
+        @return: a deferred that will fire when the node has left
         """
         
     def getValue(self, key):
-        """Get a value from the DHT for the specified key."""
+        """Get a value from the DHT for the specified key.
+        
+        The length of the key may be adjusted for use with the DHT.
+
+        @rtype: C{Deferred}
+        @return: a deferred that will fire with the stored values
+        """
         
     def storeValue(self, key, value):
-        """Store a value in the DHT for the specified key."""
+        """Store a value in the DHT for the specified key.
+
+        The length of the key may be adjusted for use with the DHT.
+        """