From 53b0b0f9af7af4ec13bf5df21c8f07fc3ed4f95b Mon Sep 17 00:00:00 2001 From: Vincent Le Goff Date: Sun, 5 Feb 2017 08:57:41 -0800 Subject: [PATCH] Update the Command.get_help() method taking Evennia's policy into account --- evennia/commands/command.py | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/evennia/commands/command.py b/evennia/commands/command.py index fefc54b8b6..965f73574c 100644 --- a/evennia/commands/command.py +++ b/evennia/commands/command.py @@ -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__