Some documentation about roster files.

1 files changed, 13 insertions, 7 deletions

diff --git a/Presence/ConfigFiles.hs b/Presence/ConfigFiles.hs
index 46d5a01c..27a65bbf 100644
--- a/Presence/ConfigFiles.hs
+++ b/Presence/ConfigFiles.hs
@@ -25,12 +25,18 @@ configDir, buddyFile, subscriberFile,
   otherFile, pendingFile, solicitedFile,
   secretsFile :: FilePath
 
+-- A "buddy" is somebody who approved our friend request and will keep
+-- us informed of their presence.
+--
+-- A "subscriber" is somebody who we approved and promised to keep informed
+-- of our own presence.
+
 configDir      = ".presence"
-buddyFile      = "buddies"
-subscriberFile = "subscribers"
+buddyFile      = "buddies"     -- subscription="to"
+subscriberFile = "subscribers" -- subscription="from"
+pendingFile    = "pending"     -- pending subscriber (we've yet to approve)
+solicitedFile  = "solicited"   -- pending buddy (we sent a friend request)
 otherFile      = "others"
-pendingFile    = "pending"
-solicitedFile  = "solicited"
 secretsFile    = "secret"
 
 
@@ -86,9 +92,9 @@ modifyFile ::
   (ByteString,FilePath)
   -> User
   -> Profile
-  -> (ByteString -> IO (Maybe ByteString)) -- Returns Just for each item you want to keep.
-  -> Maybe ByteString -- Optionally append this item.
-  -> IO Bool -- Returns True if test function ever returned Nothing
+  -> (ByteString -> IO (Maybe ByteString)) -- ^ Returns Just for each item you want to keep.
+  -> Maybe ByteString                      -- ^ Optionally append this item.
+  -> IO Bool                               -- Returns True if test function ever returned Nothing
 modifyFile (tag,file) user profile test appending = configPath user profile file >>= doit
     where
         doit path = do