From 0afc399bfc3b54269876aacdd420961748cbcdab Mon Sep 17 00:00:00 2001 From: Jeremy Fincher Date: Tue, 25 Mar 2003 06:53:51 +0000 Subject: [PATCH] Added module docstrings (which will later be used by the installer script. --- plugins/BadWords.py | 11 +++++++++++ plugins/ChannelLogger.py | 4 +++- plugins/ChannelStats.py | 9 +++++++++ plugins/Ctcp.py | 5 +++++ plugins/Factoids.py | 14 ++++++++++++++ plugins/FixRelayBot.py | 5 +++++ plugins/Forums.py | 6 ++++++ plugins/FreeBSD.py | 10 ++++++++++ plugins/FunCommands.py | 30 ++++++++++++++++++++++++++++-- plugins/FunDB.py | 18 ++++++++++++++++++ plugins/Http.py | 13 +++++++++++++ plugins/Quotes.py | 11 +++++++++++ plugins/Topic.py | 9 +++++++++ plugins/Unix.py | 9 +++++++++ plugins/Utils.py | 8 ++++++++ 15 files changed, 159 insertions(+), 3 deletions(-) diff --git a/plugins/BadWords.py b/plugins/BadWords.py index c511f0014..f51ef78a3 100644 --- a/plugins/BadWords.py +++ b/plugins/BadWords.py @@ -29,6 +29,17 @@ # POSSIBILITY OF SUCH DAMAGE. ### +""" +Filters bad words on outgoing messages from the bot, so the bot can't be made +to say bad words. + +Commands include: + addbadword + removebadword + addbadwords + removebadwords +""" + from baseplugin import * import re diff --git a/plugins/ChannelLogger.py b/plugins/ChannelLogger.py index 6f72f3b0b..f31f65c66 100644 --- a/plugins/ChannelLogger.py +++ b/plugins/ChannelLogger.py @@ -29,7 +29,9 @@ # POSSIBILITY OF SUCH DAMAGE. ### -"""Logger: Logs channels in a format similar to most IRC clients.""" +""" +Logs each channel to its own individual logfile. +""" from baseplugin import * diff --git a/plugins/ChannelStats.py b/plugins/ChannelStats.py index e558fa6e5..b4177ff39 100644 --- a/plugins/ChannelStats.py +++ b/plugins/ChannelStats.py @@ -29,6 +29,15 @@ # POSSIBILITY OF SUCH DAMAGE. ### +""" +Silently listens to every message received on a channel and keeps statistics +concerning joins, parts, and various other commands in addition to tracking +statistics about smileys, actions, characters, and words. + +Commands include: + seen +""" + from baseplugin import * import re diff --git a/plugins/Ctcp.py b/plugins/Ctcp.py index 0552f5fc0..f1132aee5 100644 --- a/plugins/Ctcp.py +++ b/plugins/Ctcp.py @@ -29,6 +29,11 @@ # POSSIBILITY OF SUCH DAMAGE. ### +""" +Handles standard CTCP responses to PING, TIME, SOURCE, VERSION, USERINFO, +and FINGER. +""" + from baseplugin import * import os diff --git a/plugins/Factoids.py b/plugins/Factoids.py index 67f6d4752..767b12dc4 100644 --- a/plugins/Factoids.py +++ b/plugins/Factoids.py @@ -29,6 +29,20 @@ # POSSIBILITY OF SUCH DAMAGE. ### +""" +Handles "factoids," little tidbits of information held in a database and +available on demand via several commands. + +Commands include: + addfactoid + removefactoid + lookupfactoid + lockfactoid + unlockfactoid + randomfactoid + factoidinfo +""" + from baseplugin import * import time diff --git a/plugins/FixRelayBot.py b/plugins/FixRelayBot.py index 15feae750..1d4980cd7 100644 --- a/plugins/FixRelayBot.py +++ b/plugins/FixRelayBot.py @@ -29,6 +29,11 @@ # POSSIBILITY OF SUCH DAMAGE. ### +""" +Allows people behind a relaybot (which uses to relay messages) +to access the bot. +""" + from baseplugin import * import re diff --git a/plugins/Forums.py b/plugins/Forums.py index ba7c9135b..562d71532 100644 --- a/plugins/Forums.py +++ b/plugins/Forums.py @@ -29,6 +29,12 @@ # POSSIBILITY OF SUCH DAMAGE. ### +""" +Reads URLs from a channel, generally for web-based forums, and messages the +channel with useful information about the URL -- its forum, title, original +poster, etc. +""" + from baseplugin import * import re diff --git a/plugins/FreeBSD.py b/plugins/FreeBSD.py index d89f2115a..511e0efa2 100755 --- a/plugins/FreeBSD.py +++ b/plugins/FreeBSD.py @@ -29,6 +29,16 @@ # POSSIBILITY OF SUCH DAMAGE. ### +""" +Provides FreeBSD ports searching and other FreeBSD-specific services. + +Commands include: + numports + searchports + randomport + portinfo +""" + from baseplugin import * import string diff --git a/plugins/FunCommands.py b/plugins/FunCommands.py index b5f83b337..23c0271cd 100644 --- a/plugins/FunCommands.py +++ b/plugins/FunCommands.py @@ -29,6 +29,34 @@ # POSSIBILITY OF SUCH DAMAGE. ### +""" +Provides a multitude of fun, useless commands. + +Commands include: + netstats + ord + chr + base + hexlify + unhexlify + xor + mimetype + md5 + sha + urlquote + urlunquote + rot13 + coin + dice + leet + cpustats + uptime + calc + objects + last + lastfrom +""" + from baseplugin import * import os @@ -315,8 +343,6 @@ class FunCommands(callbacks.Privmsg): except Exception, e: irc.reply(msg, debug.exnToString(e)) - math = calc - def objects(self, irc, msg, args): "takes no arguments. Returns the number of Python objects in memory." objs = gc.get_objects() diff --git a/plugins/FunDB.py b/plugins/FunDB.py index e1246a61d..3e92dd5f4 100755 --- a/plugins/FunDB.py +++ b/plugins/FunDB.py @@ -29,6 +29,24 @@ # POSSIBILITY OF SUCH DAMAGE. ### +""" +Provides fun commands that require a database to operate. + +Commands include: + crossword + anagram + addword + lart + addlart + removelart + excuse + addexcuse + removeexcuse + insult + addinsult + removeinsult +""" + from baseplugin import * import string diff --git a/plugins/Http.py b/plugins/Http.py index 5dc93ad0b..49cc8ca1f 100644 --- a/plugins/Http.py +++ b/plugins/Http.py @@ -29,6 +29,19 @@ # POSSIBILITY OF SUCH DAMAGE. ### +""" +Provides several commands that go out to websites and get things. + +Commands include: + freshmeat + stockquote + foldoc + gkstats + zipcode + weather + slashdot +""" + from baseplugin import * import re diff --git a/plugins/Quotes.py b/plugins/Quotes.py index f198e6f58..49aeefe68 100644 --- a/plugins/Quotes.py +++ b/plugins/Quotes.py @@ -29,6 +29,17 @@ # POSSIBILITY OF SUCH DAMAGE. ### +""" +Maintains a Quotes database for each channel. + +Commands include: + addquote + removequote + maxquote + randomquote + quoteinfo +""" + from baseplugin import * import re diff --git a/plugins/Topic.py b/plugins/Topic.py index c8e84d1a3..9f92543f7 100644 --- a/plugins/Topic.py +++ b/plugins/Topic.py @@ -29,6 +29,15 @@ # POSSIBILITY OF SUCH DAMAGE. ### +""" +Provides commands for manipulating channel topics. + +Commands include: + addtopic + removetopic + shuffletopic +""" + from baseplugin import * import re diff --git a/plugins/Unix.py b/plugins/Unix.py index 9937c96f0..5a1d0b25f 100644 --- a/plugins/Unix.py +++ b/plugins/Unix.py @@ -29,6 +29,15 @@ # POSSIBILITY OF SUCH DAMAGE. ### +""" +Provides commands available only on Unix. + +Commands include: + errno + progstats + crypt +""" + from baseplugin import * import os diff --git a/plugins/Utils.py b/plugins/Utils.py index 36d780238..0e6871415 100644 --- a/plugins/Utils.py +++ b/plugins/Utils.py @@ -29,6 +29,14 @@ # POSSIBILITY OF SUCH DAMAGE. ### +""" +Various utility commands, mostly useful for manipulating nested commands. + +Commands include: + strjoin + strconcat +""" + from baseplugin import * import privmsgs