# HG changeset patch
# User Matthew Wild <mwild1@gmail.com>
# Date 1533414797 -3600
# Node ID 86f31a2174b35f8b38e156e5c7f86330710e1fc7
# Parent  6e42ef9c805c46e5951afbef0687d7ce2d2ec152
mod_pubsub: Add comment to document nodestore/itemstore methods

diff -r 6e42ef9c805c -r 86f31a2174b3 plugins/mod_pubsub/mod_pubsub.lua
--- a/plugins/mod_pubsub/mod_pubsub.lua	Sat Aug 04 21:32:24 2018 +0100
+++ b/plugins/mod_pubsub/mod_pubsub.lua	Sat Aug 04 21:33:17 2018 +0100
@@ -25,6 +25,20 @@
 	return lib_pubsub.handle_pubsub_iq(event, service);
 end
 
+-- An itemstore supports the following methods:
+--   items(): iterator over (id, item)
+--   get(id): return item with id
+--   set(id, item): set id to item
+--   clear(): clear all items
+--   resize(n): set new limit and trim oldest items
+--   tail(): return the latest item
+
+-- A nodestore supports the following methods:
+--   set(node_name, node_data)
+--   get(node_name)
+--   users(): iterator over (node_name)
+
+
 local node_store = module:open_store(module.name.."_nodes");
 
 local function create_simple_itemstore(node_config, node_name)