From 9b76a57d589c61486f8a412cd40d595c72c7721b Mon Sep 17 00:00:00 2001
From: Matthew Wild <mwild1@gmail.com>
Date: Fri, 4 Sep 2015 11:26:51 +0100
Subject: mod_pep: Document data structures, so I don't have to spend time
 remembering every time I work on this module

---
 plugins/mod_pep.lua | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/plugins/mod_pep.lua b/plugins/mod_pep.lua
index bdb742e3..7b4c5ddc 100644
--- a/plugins/mod_pep.lua
+++ b/plugins/mod_pep.lua
@@ -17,9 +17,13 @@ local type = type;
 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()
-- 
cgit v1.2.3