add help functions to Module.py
This commit is contained in:
parent
10ec3b2213
commit
d34a134993
18
Module.py
18
Module.py
|
@ -154,5 +154,23 @@ class Module(object):
|
||||||
|
|
||||||
print("looks like someone forgot to implement do!")
|
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
|
# vi:tabstop=4:expandtab:autoindent
|
||||||
# kate: indent-mode python;indent-width 4;replace-tabs on;
|
# kate: indent-mode python;indent-width 4;replace-tabs on;
|
||||||
|
|
Loading…
Reference in New Issue