Update users home folder, clean up some scripts and add comments

home/.config/awesome/vicious/contrib/rss.lua

@@ -20,48 +20,48 @@ local rss = {}
 
 -- {{{ RSS widget type
 local function worker(format, input)
-    -- input:  * feed   - feed url
-    --         * object - entity to look for (typically: 'item')
-    --         * fields - fields to read (example: 'link', 'title', 'description')
-    -- output: * count  - number of entities found
-    --         * one table for each field, containing wanted values
-    local feed   = input.feed
-    local object = input.object
-    local fields = input.fields
+  -- input:  * feed   - feed url
+  --         * object - entity to look for (typically: 'item')
+  --         * fields - fields to read (example: 'link', 'title', 'description')
+  -- output: * count  - number of entities found
+  --         * one table for each field, containing wanted values
+  local feed   = input.feed
+  local object = input.object
+  local fields = input.fields
 
-    -- Initialise tables
-    local out = {}
+  -- Initialise tables
+  local out = {}
+
+  for _, v in pairs(fields) do
+    out[v] = {}
+  end
+
+  -- Initialise variables
+  local ob    = nil
+  local i,j,k = 1, 1, 0
+  local curl  = "curl -A 'Mozilla/4.0' -fsm 5 --connect-timeout 3 "
+
+  -- Get the feed
+  local f = io.popen(curl .. '"' .. feed .. '"')
+  local feed = f:read("*all")
+  f:close()
+
+  while true do
+    i, j, ob = feed.find(feed, "<" .. object .. ">(.-)</" .. object .. ">", i)
+    if not ob then break end
 
     for _, v in pairs(fields) do
-        out[v] = {}
+      out[v][k] = ob:match("<" .. v .. ">(.*)</" .. v .. ">")
     end
 
-    -- Initialise variables
-    local ob    = nil
-    local i,j,k = 1, 1, 0
-    local curl  = "curl -A 'Mozilla/4.0' -fsm 5 --connect-timeout 3 "
+    k = k+1
+    i = j+1
+  end
 
-    -- Get the feed
-    local f = io.popen(curl .. '"' .. feed .. '"')
-    local feed = f:read("*all")
-    f:close()
+  -- Update the entity count
+  out.count = k
 
-    while true do
-        i, j, ob = feed.find(feed, "<" .. object .. ">(.-)</" .. object .. ">", i)
-        if not ob then break end
-
-        for _, v in pairs(fields) do
-            out[v][k] = ob:match("<" .. v .. ">(.*)</" .. v .. ">")
-        end
-
-        k = k+1
-        i = j+1
-    end
-
-    -- Update the entity count
-    out.count = k
-
-    return out
+  return out
 end
 -- }}}