Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-03-16 21:06:30 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update the Command.get_help() method taking Evennia's policy into account

Browse source
This commit is contained in:
Vincent Le Goff 2017-02-05 08:57:41 -08:00 • committed by Griatch
parent 602b3408aa
commit 53b0b0f9af
1 changed files with 6 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

12
evennia/commands/command.py
View file

@ -434,15 +434,15 @@ class Command(with_metaclass(CommandMeta, object)):
By default, return self.__doc__ (the docstring just under
the class definition). You can override this behavior,
though, and even customize it depending on the caller.
though, and even customize it depending on the caller, or other
commands the caller can use.
Args:
self: the command itself.
caller: the caller asking for help on the command.
cmdset: the command set (if you need additional commands).
caller (Object or Player): the caller asking for help on the command.
cmdset (CmdSet): the command set (if you need additional commands).
This should return the string of the help message for this
command.
Returns:
docstring (str): the help text to provide the caller for this command.
"""
return self.__doc__