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

Updating ReST docs.

Browse source
This commit is contained in:
Griatch 2012-03-15 15:26:07 +01:00
parent f46a9a1280
commit 2eb5c4fc8c
39 changed files with 410 additions and 1203 deletions
Download patch file Download diff file Expand all files Collapse all files

16
docs/sphinx/source/wiki/HelpSystem.rst
View file

@ -49,16 +49,7 @@ Example (from a module with command definitions):
::
class CmdMyCmd(Command):
"""
mycmd - my very own command Usage:
mycmd[/switches] <args> Switches:
test - test the command
run - do something else This is my own command that does things to you when you
supply it with arguments. """
...
help_category = "Building"
...
class CmdMyCmd(Command): """ mycmd - my very own command Usage: mycmd[/switches] <args> Switches: test - test the command run - do something else This is my own command that does things to you when you supply it with arguments. """ ... help_category = "Building" ...
The text at the very top of the command class definition is the class'
``__doc__``-string and will be shown to users looking for help. Try to
@ -98,10 +89,7 @@ You can create new help entries in code by using
::
from src.utils import create
entry = create.create_help_entry("emote",
"Emoting is important because ...",
category="Roleplaying", locks="view:all()"):
from src.utils import create entry = create.create_help_entry("emote", "Emoting is important because ...", category="Roleplaying", locks="view:all()"):
From inside the game those with the right permissions can use the
``@sethelp`` command to add and modify help entries.