control - update help text

[erebus.git] / modules / resources.py

diff --git a/modules/resources.py b/modules/resources.py
index 520f762fb2b71e41b47672b344f9817aa278b52d..016e4bdb85913ada2775615eff5f5b1becc4ffe0 100644 (file)
--- a/modules/resources.py
+++ b/modules/resources.py
@@ -1,13 +1,14 @@
 # Erebus IRC bot - Author: Erebus Team
-# simple module example
+# resource-usage module
 # This file is released into the public domain; see http://unlicense.org/
 
 # module info
 modinfo = {
        'author': 'Erebus Team',
        'license': 'public domain',
-       'compatible': [1], # compatible module API versions
-       'depends': [], # other modules required to work properly?
+       'compatible': [1,2],
+       'depends': [],
+       'softdeps': ['help'],
 }
 
 # preamble
@@ -20,6 +21,7 @@ modstop = lib.modstop
 import resource
 
 @lib.hook(needchan=False, glevel=lib.MANAGER)
+@lib.help(None, "show RAM usage")
 def ram(bot, user, chan, realtarget, *args):
        if chan is not None and realtarget == chan.name: replyto = chan
        else: replyto = user
@@ -32,6 +34,7 @@ def ram(bot, user, chan, realtarget, *args):
        bot.fastmsg(replyto, "Memory usage (MiB): %r" % (res.ru_maxrss/1024.0))
 
 @lib.hook(needchan=False, glevel=lib.MANAGER)
+@lib.help(None, "show resource usage")
 def resources(bot, user, chan, realtarget, *args):
        if chan is not None and realtarget == chan.name: replyto = chan
        else: replyto = user