From d34a134993dce0870cc3f1220a7aa6fd0eeb5318 Mon Sep 17 00:00:00 2001 From: Mike Bloy Date: Sat, 8 Jan 2011 13:39:38 -0600 Subject: [PATCH] add help functions to Module.py --- Module.py | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/Module.py b/Module.py index 4c3cdda..e5a205c 100644 --- a/Module.py +++ b/Module.py @@ -154,5 +154,23 @@ class Module(object): print("looks like someone forgot to implement do!") + def help_description(self): + """Return a quick list of commands or other summary, should be + less than two lines. If you want the module hidden from "!help", + return None here""" + return None + + def help_summary(self): + """Return a command summary or longer description of this module. + If this returns None, the summary will be + "no help available for module foo" + """ + return None + + def help_detail(self, command): + """Return detailed help for the given command. Return None if there + is no suitable help available""" + return None + # vi:tabstop=4:expandtab:autoindent # kate: indent-mode python;indent-width 4;replace-tabs on;