# HG changeset patch
# User Matthew Wild <mwild1@gmail.com>
# Date 1441362411 -3600
# Node ID 0129ffcaa7abf383bd92e08f0967675f601d7540
# Parent  88d54bec26b7164bb75fb1027a7b743bb7f45b79
mod_pep: Document data structures, so I don't have to spend time remembering every time I work on this module

diff -r 88d54bec26b7 -r 0129ffcaa7ab plugins/mod_pep.lua
--- a/plugins/mod_pep.lua	Mon May 25 23:16:11 2015 +0100
+++ b/plugins/mod_pep.lua	Fri Sep 04 11:26:51 2015 +0100
@@ -17,9 +17,13 @@
 local calculate_hash = require "util.caps".calculate_hash;
 local core_post_stanza = prosody.core_post_stanza;
 
+-- Used as canonical 'empty table'
 local NULL = {};
+-- data[user_bare_jid][node] = item_stanza
 local data = {};
+--- recipients[user_bare_jid][contact_full_jid][subscribed_node] = true
 local recipients = {};
+-- hash_map[hash][subscribed_nodes] = true
 local hash_map = {};
 
 module.save = function()