diff --git a/plugins/Factoids/plugin.py b/plugins/Factoids/plugin.py index 8305c7f27..b9400586f 100644 --- a/plugins/Factoids/plugin.py +++ b/plugins/Factoids/plugin.py @@ -188,6 +188,7 @@ class FactoidsCallback(httpserver.SupyHTTPServerCallback): self.write('Missing field \'chan\'.') class Factoids(callbacks.Plugin, plugins.ChannelDBHandler): + """Provides the ability to show Factoids.""" def __init__(self, irc): callbacks.Plugin.__init__(self, irc) plugins.ChannelDBHandler.__init__(self) diff --git a/plugins/Format/plugin.py b/plugins/Format/plugin.py index 4417b2a17..4d68c8ada 100644 --- a/plugins/Format/plugin.py +++ b/plugins/Format/plugin.py @@ -38,6 +38,8 @@ from supybot.i18n import PluginInternationalization, internationalizeDocstring _ = PluginInternationalization('Format') class Format(callbacks.Plugin): + """Provides some commands for formatting text, such as making text bold or + capitalized.""" @internationalizeDocstring def bold(self, irc, msg, args, text): """ diff --git a/plugins/Games/plugin.py b/plugins/Games/plugin.py index 1ab43e628..d6b5ad5ed 100644 --- a/plugins/Games/plugin.py +++ b/plugins/Games/plugin.py @@ -42,6 +42,8 @@ _ = PluginInternationalization('Games') class Games(callbacks.Plugin): + """This plugin provides some small games like (Russian) roulette, + eightball, monologue, coin and dice.""" @internationalizeDocstring def coin(self, irc, msg, args): """takes no arguments diff --git a/plugins/Google/plugin.py b/plugins/Google/plugin.py index d25d02cfb..afd7137b0 100644 --- a/plugins/Google/plugin.py +++ b/plugins/Google/plugin.py @@ -49,6 +49,8 @@ _ = PluginInternationalization('Google') import json class Google(callbacks.PluginRegexp): + """This is a simple plugin to provide access to the Google services we + all know and love from our favorite IRC bot.""" threaded = True callBefore = ['Web'] regexps = ['googleSnarfer'] diff --git a/plugins/Herald/README.md b/plugins/Herald/README.md index 58bf9e2a5..305905e5a 100644 --- a/plugins/Herald/README.md +++ b/plugins/Herald/README.md @@ -1,2 +1,2 @@ -This plugin allows you to set welcoming messages (heralds) to people who are regognized by the bot -when they join the channel. +This plugin allows you to set welcome messages (heralds) to people who are recognized by the bot +when they join a channel. diff --git a/plugins/Herald/plugin.py b/plugins/Herald/plugin.py index b398362d1..058fa8158 100644 --- a/plugins/Herald/plugin.py +++ b/plugins/Herald/plugin.py @@ -55,6 +55,8 @@ class HeraldDB(plugins.ChannelUserDB): return L[0] class Herald(callbacks.Plugin): + """This plugin allows you to set welcome messages (heralds) to people who + are recognized by the bot when they join a channel.""" def __init__(self, irc): self.__parent = super(Herald, self) self.__parent.__init__(irc) diff --git a/plugins/Internet/README.md b/plugins/Internet/README.md index a267eed98..6f5dcf06c 100644 --- a/plugins/Internet/README.md +++ b/plugins/Internet/README.md @@ -1,2 +1,2 @@ -This plugin provides commands to transform domain into IP address and IP address to domain. -It also provides command to search WHOIS information. This plugin can also return hexips. +This plugin provides commands to transform domains into IP addresses and IP addresses to domains. +It can also search WHOIS information and return hexips. diff --git a/plugins/Internet/plugin.py b/plugins/Internet/plugin.py index f86cd24dd..9cc249614 100644 --- a/plugins/Internet/plugin.py +++ b/plugins/Internet/plugin.py @@ -40,7 +40,8 @@ from supybot.i18n import PluginInternationalization, internationalizeDocstring _ = PluginInternationalization('Internet') class Internet(callbacks.Plugin): - """Add the help for "@help Internet" here.""" + """Provides commands to query DNS, search WHOIS databases, + and convert IPs to hex.""" threaded = True @internationalizeDocstring def dns(self, irc, msg, args, host): diff --git a/plugins/Karma/plugin.py b/plugins/Karma/plugin.py index 70f2cdc94..2b8671530 100644 --- a/plugins/Karma/plugin.py +++ b/plugins/Karma/plugin.py @@ -219,6 +219,7 @@ KarmaDB = plugins.DB('Karma', {'sqlite3': SqliteKarmaDB}) class Karma(callbacks.Plugin): + """Provides a simple tracker for setting Karma (thing++, thing--).""" callBefore = ('Factoids', 'MoobotFactoids', 'Infobot') def __init__(self, irc): self.__parent = super(Karma, self) @@ -243,7 +244,7 @@ class Karma(callbacks.Plugin): irc.noReply() def _doKarma(self, irc, msg, channel, thing): - inc = self.registryValue('incrementChars', channel) + inc = self.registryValue('incrementChars', channel) dec = self.registryValue('decrementChars', channel) if thing.endswith(tuple(inc + dec)): for s in inc: diff --git a/plugins/Lart/plugin.py b/plugins/Lart/plugin.py index 4bc3f5ee3..56382c219 100644 --- a/plugins/Lart/plugin.py +++ b/plugins/Lart/plugin.py @@ -36,6 +36,8 @@ from supybot.i18n import PluginInternationalization, internationalizeDocstring _ = PluginInternationalization('Lart') class Lart(plugins.ChannelIdDatabasePlugin): + """Provides an implementation of the Luser Attitude Readjustment Tool + for users.""" _meRe = re.compile(r'\bme\b', re.I) _myRe = re.compile(r'\bmy\b', re.I) def _replaceFirstPerson(self, s, nick): diff --git a/plugins/Math/plugin.py b/plugins/Math/plugin.py index 123f4b0ff..e057bf6af 100644 --- a/plugins/Math/plugin.py +++ b/plugins/Math/plugin.py @@ -50,6 +50,8 @@ except ImportError: baseArg = ('int', 'base', lambda i: i <= 36) class Math(callbacks.Plugin): + """Provides commands to work with math, such as a calculator and + a unit converter.""" @internationalizeDocstring def base(self, irc, msg, args, frm, to, number): """ [] diff --git a/plugins/Misc/plugin.py b/plugins/Misc/plugin.py index 5d75ffe77..9b184578d 100644 --- a/plugins/Misc/plugin.py +++ b/plugins/Misc/plugin.py @@ -76,6 +76,8 @@ class RegexpTimeout(Exception): pass class Misc(callbacks.Plugin): + """Miscellaneous commands to access Supybot core. This is a core Supybot + module that should not be removed!""" def __init__(self, irc): self.__parent = super(Misc, self) self.__parent.__init__(irc) diff --git a/plugins/MoobotFactoids/plugin.py b/plugins/MoobotFactoids/plugin.py index 6f3d972b5..d10305dad 100755 --- a/plugins/MoobotFactoids/plugin.py +++ b/plugins/MoobotFactoids/plugin.py @@ -285,8 +285,8 @@ class SqliteMoobotDB(object): MoobotDB = plugins.DB('MoobotFactoids', {'sqlite3': SqliteMoobotDB}) class MoobotFactoids(callbacks.Plugin): - """Add the help for "@help MoobotFactoids" here (assuming you don't implement a MoobotFactoids - command). This should describe *how* to use this plugin.""" + """An alternative to the Factoids plugin, this plugin keeps factoids in + your bot.""" callBefore = ['Dunno'] def __init__(self, irc): self.db = MoobotDB() diff --git a/plugins/Network/README.md b/plugins/Network/README.md index 539a607a0..be500983f 100644 --- a/plugins/Network/README.md +++ b/plugins/Network/README.md @@ -1 +1 @@ -Allows connecting, reconnecting, display the bot's latency between the server and other useful network-related commands. \ No newline at end of file +Allows connecting/disconnecting to networks, displaying the bot's latency to the server, and other useful network-related commands. diff --git a/plugins/Network/plugin.py b/plugins/Network/plugin.py index 1747f731d..a678e03eb 100644 --- a/plugins/Network/plugin.py +++ b/plugins/Network/plugin.py @@ -43,6 +43,8 @@ from supybot.i18n import PluginInternationalization, internationalizeDocstring _ = PluginInternationalization('Network') class Network(callbacks.Plugin): + """Provides network-related commands, such as connecting to multiple networks + and checking latency to the server.""" _whois = {} _latency = {} def _getIrc(self, network): diff --git a/plugins/News/plugin.py b/plugins/News/plugin.py index 599225fd7..d5d262e19 100644 --- a/plugins/News/plugin.py +++ b/plugins/News/plugin.py @@ -106,6 +106,7 @@ class DbiNewsDB(plugins.DbiChannelDB): NewsDB = plugins.DB('News', {'flat': DbiNewsDB}) class News(callbacks.Plugin): + """This plugin provides a means of maintaining News for a channel.""" def __init__(self, irc): self.__parent = super(News, self) self.__parent.__init__(irc) diff --git a/plugins/NickAuth/plugin.py b/plugins/NickAuth/plugin.py index ab8dada76..82edcf177 100644 --- a/plugins/NickAuth/plugin.py +++ b/plugins/NickAuth/plugin.py @@ -44,7 +44,7 @@ _ = PluginInternationalization('NickAuth') @internationalizeDocstring class NickAuth(callbacks.Plugin): - """Support authentication based on nicks and network services.""" + """Supports authentication based on nicks and network services.""" def __init__(self, irc): super(NickAuth, self).__init__(irc) self._requests = {} diff --git a/plugins/Nickometer/plugin.py b/plugins/Nickometer/plugin.py index cf9da917d..ad4c83ab5 100644 --- a/plugins/Nickometer/plugin.py +++ b/plugins/Nickometer/plugin.py @@ -78,6 +78,7 @@ def numberShifts(s): return len(s)-1 class Nickometer(callbacks.Plugin): + """Will tell you how lame a nick is by the command `@nickometer [nick]`.""" def punish(self, damage, reason): self.log.debug('%s lameness points awarded: %s', damage, reason) return damage diff --git a/plugins/Note/plugin.py b/plugins/Note/plugin.py index 31cebcc66..ccf789b7b 100644 --- a/plugins/Note/plugin.py +++ b/plugins/Note/plugin.py @@ -122,6 +122,7 @@ class DbiNoteDB(dbi.DB): NoteDB = plugins.DB('Note', {'flat': DbiNoteDB}) class Note(callbacks.Plugin): + """Allows you to send notes to other users.""" def __init__(self, irc): self.__parent= super(Note, self) self.__parent.__init__(irc) diff --git a/plugins/Owner/plugin.py b/plugins/Owner/plugin.py index bf080f1b4..8f5afc245 100644 --- a/plugins/Owner/plugin.py +++ b/plugins/Owner/plugin.py @@ -79,6 +79,8 @@ registerDefaultPlugin('addcapability', 'Admin') registerDefaultPlugin('removecapability', 'Admin') class Owner(callbacks.Plugin): + """Owner-only commands for core Supybot. This is a core Supybot module + that should not be removed!""" # This plugin must be first; its priority must be lowest; otherwise odd # things will happen when adding callbacks. def __init__(self, irc=None): diff --git a/plugins/Protector/plugin.py b/plugins/Protector/plugin.py index 26a1b8824..026e3e26f 100644 --- a/plugins/Protector/plugin.py +++ b/plugins/Protector/plugin.py @@ -36,6 +36,8 @@ from supybot.i18n import PluginInternationalization, internationalizeDocstring _ = PluginInternationalization('Protector') class Protector(callbacks.Plugin): + """Prevents users from doing things they are not supposed to do on a channel, + even if they have +o or +h.""" def isImmune(self, irc, msg): if not ircutils.isUserHostmask(msg.prefix): self.log.debug('%q is immune, it\'s a server.', msg) diff --git a/plugins/Quote/plugin.py b/plugins/Quote/plugin.py index c18bc750d..5b01f1b83 100644 --- a/plugins/Quote/plugin.py +++ b/plugins/Quote/plugin.py @@ -33,6 +33,7 @@ from supybot.i18n import PluginInternationalization, internationalizeDocstring _ = PluginInternationalization('Quote') class Quote(plugins.ChannelIdDatabasePlugin): + """This plugin allows you to add quotes to the database for a channel.""" @internationalizeDocstring def random(self, irc, msg, args, channel): """[] diff --git a/plugins/QuoteGrabs/plugin.py b/plugins/QuoteGrabs/plugin.py index 9721f8a81..2979f9b7f 100644 --- a/plugins/QuoteGrabs/plugin.py +++ b/plugins/QuoteGrabs/plugin.py @@ -223,7 +223,8 @@ class SqliteQuoteGrabsDB(object): QuoteGrabsDB = plugins.DB('QuoteGrabs', {'sqlite3': SqliteQuoteGrabsDB}) class QuoteGrabs(callbacks.Plugin): - """Add the help for "@help QuoteGrabs" here.""" + """Stores and displays quotes from channels. Quotes are stored randomly + and/or on user request.""" def __init__(self, irc): self.__parent = super(QuoteGrabs, self) self.__parent.__init__(irc) diff --git a/plugins/Relay/plugin.py b/plugins/Relay/plugin.py index a3ccf4592..2b86ebcf0 100644 --- a/plugins/Relay/plugin.py +++ b/plugins/Relay/plugin.py @@ -43,6 +43,7 @@ from supybot.i18n import PluginInternationalization, internationalizeDocstring _ = PluginInternationalization('Relay') class Relay(callbacks.Plugin): + """This plugin allows you to setup a relay between networks.""" noIgnore = True def __init__(self, irc): self.__parent = super(Relay, self) diff --git a/plugins/Scheduler/README.md b/plugins/Scheduler/README.md index b1871c772..68b593302 100644 --- a/plugins/Scheduler/README.md +++ b/plugins/Scheduler/README.md @@ -1,2 +1,2 @@ -This plugin allows you to scheduler commands to execute at a later time. +This plugin allows you to schedule commands to execute at a later time. For example, `scheduler add [time seconds 30m] "utilities echo [status cpu]"` will schedule the command `cpu` to be sent to the channel in 30 minutes. diff --git a/plugins/Scheduler/plugin.py b/plugins/Scheduler/plugin.py index 28d34b631..3b735d6d5 100644 --- a/plugins/Scheduler/plugin.py +++ b/plugins/Scheduler/plugin.py @@ -46,6 +46,7 @@ datadir = conf.supybot.directories.data() filename = conf.supybot.directories.data.dirize('Scheduler.pickle') class Scheduler(callbacks.Plugin): + """This plugin allows you to schedule commands to execute at a later time.""" def __init__(self, irc): self.__parent = super(Scheduler, self) self.__parent.__init__(irc) diff --git a/plugins/Seen/plugin.py b/plugins/Seen/plugin.py index 8bafb2e31..6eee89c26 100644 --- a/plugins/Seen/plugin.py +++ b/plugins/Seen/plugin.py @@ -93,6 +93,8 @@ filename = conf.supybot.directories.data.dirize('Seen.db') anyfilename = conf.supybot.directories.data.dirize('Seen.any.db') class Seen(callbacks.Plugin): + """This plugin allows you to see when and what someone last said and + what you missed since you left a channel.""" noIgnore = True def __init__(self, irc): self.__parent = super(Seen, self) diff --git a/plugins/ShrinkUrl/plugin.py b/plugins/ShrinkUrl/plugin.py index 40cf3a90e..ef0cdb1a7 100644 --- a/plugins/ShrinkUrl/plugin.py +++ b/plugins/ShrinkUrl/plugin.py @@ -87,6 +87,8 @@ def retry(f): return newf class ShrinkUrl(callbacks.PluginRegexp): + """This plugin features commands to shorten URLs through different services, + like tinyurl.""" regexps = ['shrinkSnarfer'] def __init__(self, irc): self.__parent = super(ShrinkUrl, self) diff --git a/plugins/Status/plugin.py b/plugins/Status/plugin.py index 3b7a7f0d1..7e9ac2b1b 100644 --- a/plugins/Status/plugin.py +++ b/plugins/Status/plugin.py @@ -44,6 +44,8 @@ from supybot.i18n import PluginInternationalization, internationalizeDocstring _ = PluginInternationalization('Status') class Status(callbacks.Plugin): + """This plugin allows you to view different bot statistics, for example, + uptime.""" def __init__(self, irc): self.__parent = super(Status, self) self.__parent.__init__(irc) diff --git a/plugins/String/README.md b/plugins/String/README.md index 6bd83258e..64d682c32 100644 --- a/plugins/String/README.md +++ b/plugins/String/README.md @@ -1 +1 @@ -Useful commands for manipulating characters strings. +Useful commands for manipulating characters and strings. diff --git a/plugins/String/plugin.py b/plugins/String/plugin.py index 580246bcc..3d59eda62 100644 --- a/plugins/String/plugin.py +++ b/plugins/String/plugin.py @@ -48,6 +48,7 @@ _ = PluginInternationalization('String') import multiprocessing class String(callbacks.Plugin): + """Provides useful commands for manipulating characters and strings.""" @internationalizeDocstring def ord(self, irc, msg, args, letter): """ diff --git a/plugins/Time/plugin.py b/plugins/Time/plugin.py index 3a6ade5ea..8ba323c7a 100644 --- a/plugins/Time/plugin.py +++ b/plugins/Time/plugin.py @@ -64,6 +64,7 @@ except ImportError: tzlocal = None class Time(callbacks.Plugin): + """This plugin allows you to use different time-related functions.""" @internationalizeDocstring def seconds(self, irc, msg, args): """[y] [w] [d] [h] [m] [s] diff --git a/plugins/Todo/plugin.py b/plugins/Todo/plugin.py index 9e1443ebb..2809039cd 100644 --- a/plugins/Todo/plugin.py +++ b/plugins/Todo/plugin.py @@ -119,6 +119,8 @@ class FlatTodoDb(object): db.set(tid, t) class Todo(callbacks.Plugin): + """This plugin allows you to create your own personal to-do list on + the bot.""" def __init__(self, irc): self.__parent = super(Todo, self) self.__parent.__init__(irc) diff --git a/plugins/Topic/plugin.py b/plugins/Topic/plugin.py index f091df6a4..1908b7aac 100644 --- a/plugins/Topic/plugin.py +++ b/plugins/Topic/plugin.py @@ -111,6 +111,8 @@ datadir = conf.supybot.directories.data() filename = conf.supybot.directories.data.dirize('Topic.pickle') class Topic(callbacks.Plugin): + """This plugin allows you to use many topic-related functions, + such as Add, Undo, and Remove.""" def __init__(self, irc): self.__parent = super(Topic, self) self.__parent.__init__(irc) diff --git a/plugins/URL/plugin.py b/plugins/URL/plugin.py index efae3fdc6..7d3ce4e52 100644 --- a/plugins/URL/plugin.py +++ b/plugins/URL/plugin.py @@ -62,6 +62,8 @@ class DbiUrlDB(plugins.DbiChannelDB): URLDB = plugins.DB('URL', {'flat': DbiUrlDB}) class URL(callbacks.Plugin): + """This plugin records how many URLs have been mentioned in + a channel and what the last URL was.""" def __init__(self, irc): self.__parent = super(URL, self) self.__parent.__init__(irc) diff --git a/plugins/Unix/plugin.py b/plugins/Unix/plugin.py index 0f2495739..b0c614a98 100644 --- a/plugins/Unix/plugin.py +++ b/plugins/Unix/plugin.py @@ -71,6 +71,7 @@ def pipeReadline(fd, timeout=2): raise TimeoutError class Unix(callbacks.Plugin): + """Provides Utilities for Unix-like systems.""" threaded = True @internationalizeDocstring def errno(self, irc, msg, args, s): diff --git a/plugins/User/plugin.py b/plugins/User/plugin.py index 890a3946f..bbf8d9df9 100644 --- a/plugins/User/plugin.py +++ b/plugins/User/plugin.py @@ -44,6 +44,9 @@ from supybot.i18n import PluginInternationalization, internationalizeDocstring _ = PluginInternationalization('User') class User(callbacks.Plugin): + """Provides commands for dealing with users, such as registration and + authentication to the bot. This is a core Supybot module that should + not be removed!""" def _checkNotChannel(self, irc, msg, password=' '): if password and irc.isChannel(msg.args[0]): raise callbacks.Error(conf.supybot.replies.requiresPrivacy()) diff --git a/plugins/Utilities/README.md b/plugins/Utilities/README.md index 575a9abb5..e63c0c155 100644 --- a/plugins/Utilities/README.md +++ b/plugins/Utilities/README.md @@ -1 +1 @@ -Provides useful commands for bot scripting / commands nesting. +Provides useful commands for bot scripting / command nesting. diff --git a/plugins/Utilities/plugin.py b/plugins/Utilities/plugin.py index 50d999a54..e645d1bfe 100644 --- a/plugins/Utilities/plugin.py +++ b/plugins/Utilities/plugin.py @@ -38,6 +38,7 @@ from supybot.i18n import PluginInternationalization, internationalizeDocstring _ = PluginInternationalization('Utilities') class Utilities(callbacks.Plugin): + """Provides useful commands for bot scripting / command nesting.""" # Yes, I really do mean "requires no arguments" below. "takes no # arguments" would probably lead people to think it was a useless command. @internationalizeDocstring diff --git a/plugins/Web/README.md b/plugins/Web/README.md index 89ce9e849..41b49a3d7 100644 --- a/plugins/Web/README.md +++ b/plugins/Web/README.md @@ -1 +1 @@ -This plugin allows you to view website information, like a title. \ No newline at end of file +This plugin allows you to view website information, like the title of a page. Also provides a Snarfer for URLs. diff --git a/sandbox/Debug/plugin.py b/sandbox/Debug/plugin.py index 7c4dcce0d..dda744e55 100644 --- a/sandbox/Debug/plugin.py +++ b/sandbox/Debug/plugin.py @@ -66,6 +66,8 @@ def getTracer(fd): return tracer class Debug(callbacks.Privmsg): + """This plugin provides debugging abilities for Supybot. It + should not be loaded with a default installation.""" capability = 'owner' def __init__(self, irc): # Setup exec command.