From fb2cd452e963b8bc048161036903cd82d3b113f0 Mon Sep 17 00:00:00 2001
From: "Sean B. Palmer" <http://inamidst.com/sbp/>
Date: Mon, 10 Mar 2008 19:58:28 +0000
Subject: Some documentation and minor fixes.

---
 modules/admin.py | 5 +++++
 1 file changed, 5 insertions(+)

(limited to 'modules/admin.py')

diff --git a/modules/admin.py b/modules/admin.py
index de2a7a7..24b8fb6 100755
--- a/modules/admin.py
+++ b/modules/admin.py
@@ -8,22 +8,27 @@ http://inamidst.com/phenny/
 """
 
 def join(phenny, input): 
+   """Join the specified channel. This is an admin-only command."""
    # Can only be done in privmsg by an admin
    if input.sender.startswith('#'): return
    if input.admin: 
       phenny.write(['JOIN'], input.group(2))
 join.commands = ['join']
 join.priority = 'low'
+join.example = '.join #example'
 
 def part(phenny, input): 
+   """Part the specified channel. This is an admin-only command."""
    # Can only be done in privmsg by an admin
    if input.sender.startswith('#'): return
    if input.admin: 
       phenny.write(['PART'], input.group(2))
 part.commands = ['part']
 part.priority = 'low'
+part.example = '.part #example'
 
 def quit(phenny, input): 
+   """Quit from the server. This is an owner-only command."""
    # Can only be done in privmsg by the owner
    if input.sender.startswith('#'): return
    if input.owner: 
-- 
cgit v1.2.3-1-g7c22