Help well formatted

plugins/echo.lua

@@ -4,8 +4,8 @@ function run(msg, matches)
 end
 
 return {
-    description = "echoes the msg", 
+    description = "Simplest plugin ever!",
-    usage = "!echo [whatever]",
+    usage = "!echo [whatever]: echoes the msg",
     patterns = {"^!echo (.*)$"}, 
     run = run 
 }

plugins/get.lua

@@ -72,8 +72,8 @@ function lex(msg, text)
 end
 
 return {
-    description = "retrieves variables saved with !set", 
+    description = "Retrieves variables saved with !set", 
-    usage = "!get (value_name)",
+    usage = "!get (value_name): Returns the value_name value.",
     patterns = {
       "^!get (%a+)$",
       "^!get$"},

plugins/google.lua

@@ -29,7 +29,7 @@ end
 
 return {
    description = "Searches Google and send results",
-   usage = "!google [terms]",
+   usage = "!google [terms]: Searches Google and send results",
    patterns = {
       "^!google (.*)$",
       "^%.[g|G]oogle (.*)$"

plugins/gps.lua

@@ -25,7 +25,7 @@ end
 
 return {
     description = "generates a map showing the given GPS coordinates", 
-    usage = "!gps latitude,longitude",
+    usage = "!gps latitude,longitude: generates a map showing the given GPS coordinates",
     patterns = {"^!gps ([^,]*)[,%s]([^,]*)$"}, 
     run = run 
 }

plugins/help.lua

@@ -30,18 +30,23 @@ function html_help()
   return text
 end
 
+function has_usage_data(dict)
+  if (dict.usage == nil or dict.usage == '') then
+    return false
+  end
+  return true
+end
+
 function telegram_help( )
   local ret = ""
   for k, dict in pairs(plugins) do
-    if dict.usage ~= "" then
     if (type(dict.usage) == "table") then
-        for ku,vu in pairs(dict.usage) do
+      for ku,usage in pairs(dict.usage) do
-          ret = ret..vu.." "
+        ret = ret..usage..'\n'
       end
-      else
+      ret = ret..'\n'
-        ret = ret..dict.usage
+    elseif has_usage_data(dict) then -- Is not empty
-      end
+      ret = ret..dict.usage..'\n\n'
-      ret = ret .. " -> " .. dict.description .. "\n"
     end
   end
   return ret
@@ -56,8 +61,11 @@ function run(msg, matches)
 end
 
 return {
-    description = "Lists all available commands", 
+    description = "Help plugin. Get info from other plugins.  ", 
-    usage = {"!help", "!help md"},
+    usage = {
+      "!help: Show all the help",
+      "!help md: Generate a GitHub Markdown table"
+    },
     patterns = {
       "^!help$",
       "^!help md$"

plugins/img_google.lua

@@ -25,8 +25,8 @@ function run(msg, matches)
 end
 
 return {
-    description = "search image with Google API and sends it", 
+    description = "Search image with Google API and sends it.", 
-    usage = "!img [topic]",
+    usage = "!img [term]: Random search an image with Google API.",
     patterns = {"^!img (.*)$"}, 
     run = run 
 }

plugins/location.lua

@@ -64,7 +64,7 @@ end
 
 return {
     description = "Gets information about a location, maplink and overview", 
-    usage = "!loc (location)",
+    usage = "!loc (location): Gets information about a location, maplink and overview",
     patterns = {"^!loc (.*)$"}, 
     run = run 
 }

plugins/plugins.lua

@@ -100,12 +100,12 @@ function run(msg, matches)
 end
 
 return {
-	description = "Enables, disables and reloads plugins. Privileged users only.", 
+	description = "Plugin to manage other plugins. Enable, disable or reload.", 
 	usage = {
 		"!plugins: list all plugins", 
-		"!plugins enable [plugin]",
+		"!plugins enable [plugin]: enable plugin",
-		"!plugins disable [plugin]",
+		"!plugins disable [plugin]: disable plugin",
-		"!plugins reload" },
+		"!plugins reload: reloads all plugins" },
 	patterns = {
 		"^!plugins$",
 		"^!plugins? (enable) (.*)$",

plugins/rae.lua

@@ -41,7 +41,7 @@ end
 
 return {
   description = "Spanish dictionary", 
-  usage = "!rae [word]",
+  usage = "!rae [word]: Search that word in Spanish dictionary. Powered by https://github.com/javierhonduco/dulcinea",
   patterns = {"^!rae (.*)$"}, 
   run = run 
 }

plugins/set.lua

@@ -23,8 +23,8 @@ function run(msg, matches)
 end
 
 return {
-    description = "Set value", 
+    description = "Plugin for saving values. get.lua plugin is necesary to retrieve them.", 
-    usage = "!set [value_name] [data]",
+    usage = "!set [value_name] [data]: Saves the data with the value_name name.",
     patterns = {"^!set (%a+) (.+)$"}, 
     run = run 
 }

plugins/stats.lua

@@ -102,8 +102,8 @@ end
 _stats = read_file_stats()
 
 return {
-    description = "Number of messages by user", 
+    description = "Plugin to update user stats.", 
-    usage = "!stats",
+    usage = "!stats: Returns a list of Username [telegram_id]: msg_num",
     patterns = {
       ".*",
     	"^!(stats)"

plugins/time.lua

@@ -94,7 +94,7 @@ end
 
 return {
     description = "Displays the local time in an area", 
-    usage = "!time [area]",
+    usage = "!time [area]: Displays the local time in that area",
     patterns = {"^!time (.*)$"}, 
     run = run
 }

plugins/twitter_send.lua

@@ -44,7 +44,7 @@ end
 
 return {
     description = "Sends a tweet", 
-    usage = "!tw [text]",
+    usage = "!tw [text]: Sends the Tweet with the configured accout.",
     patterns = {"^!tw (.+)"}, 
     run = run
 }

plugins/version.lua

@@ -7,8 +7,10 @@ end
 
 return {
     description = "Shows bot version", 
-    usage = "!version",
+    usage = "!version: Shows bot version",
-    patterns = {"^!version$"}, 
+    patterns = {
+      "^!version$"
+    }, 
     run = run 
 }