Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-04-02 05:57:16 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Make some docstring updates.

Browse source
This commit is contained in:
Griatch 2016-10-02 21:59:19 +02:00
parent 00c64b10bb
commit 40a985c791
1 changed files with 10 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

14
evennia/__init__.py
View file

@ -2,12 +2,18 @@
Evennia MUD/MUX/MU* creation system
This is the main top-level API for Evennia. You can also explore the
evennia library by accessing evennia.<subpackage> directly.
evennia library by accessing evennia.<subpackage> directly. From
inside the game you can read docs of all object by viewing its
`__doc__` string, such as through
@py evennia.ObjectDB.__doc__
For full functionality you should explore this module via a django-
aware shell. Go to your game directory and use the command
evennia shell
For full functionality you need to explore this module via a django-
aware shell. Go to your game directory and use the command 'evennia.py shell'
to launch such a shell (using python or ipython depending on your install).
See www.evennia.com for full documentation.
"""