changeset 125:0d7b95fb2549

Add documentation to set_configuration().
author Ralph Meijer <ralphm@ik.nu>
date Tue, 12 Apr 2005 14:51:59 +0000
parents c4ee16bc48e5
children ffc3c706b0fb
files idavoll/storage.py
diffstat 1 files changed, 9 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/idavoll/storage.py	Tue Apr 12 12:34:25 2005 +0000
+++ b/idavoll/storage.py	Tue Apr 12 14:51:59 2005 +0000
@@ -112,7 +112,15 @@
         """
 
     def set_configuration(self, options):
-        """ """
+        """ Set node's configuration.
+        
+        The elements of {options} will set the new values for those
+        configuration items. This means that only changing items have to
+        be given.
+
+        @param options: a dictionary of configuration options.
+        @returns: a deferred that fires upon success.
+        """
 
     def get_affiliation(self, entity):
         """ Get affiliation of entity with this node.