From 40a985c7917d5b5a5e6871ad6fbe5018cba5b3be Mon Sep 17 00:00:00 2001 From: Griatch Date: Sun, 2 Oct 2016 21:59:19 +0200 Subject: [PATCH] Make some docstring updates. --- evennia/__init__.py | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/evennia/__init__.py b/evennia/__init__.py index 558eae9bb7..f828f06113 100644 --- a/evennia/__init__.py +++ b/evennia/__init__.py @@ -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. directly. +evennia library by accessing evennia. 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. """