# HG changeset patch # User Ralph Meijer # Date 1112993978 0 # Node ID 06bab3d2490de7ea3ad325af991fa7b0c4e35be4 # Parent 97f10cfea28c8306fd6ba1d15dbb3efd543ca575 Added more documentation. diff -r 97f10cfea28c -r 06bab3d2490d idavoll/storage.py --- a/idavoll/storage.py Fri Apr 08 20:59:21 2005 +0000 +++ b/idavoll/storage.py Fri Apr 08 20:59:38 2005 +0000 @@ -84,13 +84,28 @@ class INode(Interface): """ """ def get_type(self): - """ """ + """ Get node's type. + + @return: C{'leaf'} or C{'collection'}. + """ def get_configuration(self): - """ """ + """ Get node's configuration. + + The configuration must at least have two options: + C{pubsub#persist_items}, and C{pubsub#deliver_payloads}. + + @return: L{dict} of configuration options. + """ def get_meta_data(self): - """ """ + """ Get node's meta data. + + The meta data must be a superset of the configuration options, and + also at least should have a C{pubsub#node_type} entry. + + @return: L{dict} of meta data. + """ def set_configuration(self, options): """ """