Add a method to customize the help message of a command #1195
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Brief overview of PR changes/additions
This pull request adds a method 'get_help' to all commands. By default, this method simply returns the command's docstring, but one can create a command that still uses 'auto_help', but displays a customizable message.
Motivation for adding to Evennia
The 'auto_help' system is great, but it's either on or off. This pull request offers an alternative: a way to customize the help of commands without rejecting their docstring.
Example: I have a set of commands with sub-commands (separated by spaces), like "room" (master command), "room list" (see the list of rooms in the area), "room name" (change the name of the room) and so on. When one enters "help room", he/she should see the other sub-commands available. Updating the "room" docstring could increase the potential for errors. But the help system could auto-generate help for this command (and sub-commands) very easily.