From 88dcdc95eb0268a007bc2cb7d156d42abc818f2c Mon Sep 17 00:00:00 2001 From: Greg Taylor Date: Wed, 23 May 2007 19:52:55 +0000 Subject: [PATCH] Some documentation fixups that I noticed off-hand. --- commands_privileged.py | 6 +++--- events.py | 2 +- scheduler.py | 4 +++- 3 files changed, 7 insertions(+), 5 deletions(-) diff --git a/commands_privileged.py b/commands_privileged.py index bcd80862ba..423c53c58d 100644 --- a/commands_privileged.py +++ b/commands_privileged.py @@ -10,10 +10,10 @@ import functions_general import functions_db import commands_general import ansi + """ -Any command here is prefixed by an '@' sign, usually denoting a -builder, staff or otherwise manipulative command that doesn't fall within -the scope of normal gameplay. +This file contains commands that require special permissions to use. These +are generally @-prefixed commands, but there are exceptions. """ def cmd_reload(cdat): diff --git a/events.py b/events.py index c6bcd4d16e..8c80be5752 100644 --- a/events.py +++ b/events.py @@ -6,7 +6,7 @@ import session_mgr Holds the events scheduled in scheduler.py. """ -def check_sessions(): +def evt_check_sessions(): """ Event: Check all of the connected sessions. """ diff --git a/scheduler.py b/scheduler.py index c901b47e36..6bfd7b53e6 100644 --- a/scheduler.py +++ b/scheduler.py @@ -2,6 +2,8 @@ import time from twisted.internet import task import events """ +This file contains the event scheduler system. + ADDING AN EVENT: * Create an event function to call. * Add an entry to the 'schedule' dictionary here. @@ -11,7 +13,7 @@ ADDING AN EVENT: # Dictionary of events with a list in the form of: # [, , , , ] schedule = { - 'check_sessions': [events.check_sessions, 60, time.time(), None, "Session consistency checks."] + 'evt_check_sessions': [events.evt_check_sessions, 60, time.time(), None, "Session consistency checks."] } def start_events():