modlib - clarify levels

diff --git a/modlib.py b/modlib.py
index 721fa2d9b375d8a96a92d9bb17ace6d866096d66..51018f4bd424113bdbb378667dd0f56e83d745bc 100644 (file)
--- a/modlib.py
+++ b/modlib.py
@@ -11,8 +11,8 @@ if sys.version_info.major < 3:
 else:
        stringbase = str
 
+"""Used to return an error to the bot core."""
 class error(object):
-       """Used to return an error to the bot core."""
        def __init__(self, desc):
                self.errormsg = desc
        def __nonzero__(self):
@@ -29,9 +29,9 @@ class modlib(object):
        MANAGER =  99
        ADMIN   =  75
        STAFF   =  50
-       AUTHED  =   0
-       ANYONE  =  -1
-       IGNORED =  -2
+       AUTHED  =   0 # Users which have are known to be authed
+       ANYONE  =  -1 # non-authed users have glevel set to -1
+       IGNORED =  -2 # The default reqglevel is ANYONE, so any commands will be ignored from IGNORED users unless the command reglevel=-2
 
        # (channel) access levels
        COWNER  =   5
@@ -39,8 +39,8 @@ class modlib(object):
        OP      =   3
        VOICE   =   2
        KNOWN   =   1
-       PUBLIC  =   0 #anyone (use glevel to control auth-needed)
-       BANNED  =  -1
+       PUBLIC  =   0 # Anyone (use glevel to control whether auth is needed)
+       BANNED  =  -1 # The default reqclevel is PUBLIC, so any commands which needchan will be ignored from BANNED users unless the command reqclevel=-1
        #         [   0         1        2     3         4        5    -1]
        clevs   = [None, 'Friend', 'Voice', 'Op', 'Master', 'Owner', None]