From 74655e42033f6bc7d72b6b583e9494aa0d575d7b Mon Sep 17 00:00:00 2001 From: James Lu Date: Sat, 29 Nov 2014 23:18:44 -0800 Subject: [PATCH] Add help for the following plugins (ref #903): - Admin - Alias - AutoMode - Channel - ChannelLogger - ChannelStats - Conditional - Config - Ctcp - Dict - Also, proofread Aka's help from #904 for grammar. --- plugins/Admin/plugin.py | 3 +++ plugins/Aka/plugin.py | 6 +++--- plugins/Alias/plugin.py | 2 ++ plugins/AutoMode/plugin.py | 2 ++ plugins/Channel/plugin.py | 3 +++ plugins/ChannelLogger/plugin.py | 1 + plugins/ChannelStats/plugin.py | 2 ++ plugins/Conditional/plugin.py | 5 +++-- plugins/Config/plugin.py | 2 ++ plugins/Ctcp/plugin.py | 2 ++ plugins/Dict/plugin.py | 2 ++ 11 files changed, 25 insertions(+), 5 deletions(-) diff --git a/plugins/Admin/plugin.py b/plugins/Admin/plugin.py index d27713c7d..8f417d261 100644 --- a/plugins/Admin/plugin.py +++ b/plugins/Admin/plugin.py @@ -43,6 +43,9 @@ from supybot.i18n import PluginInternationalization, internationalizeDocstring _ = PluginInternationalization('Admin') class Admin(callbacks.Plugin): + """This plugin provides access to administrative commands, such as + adding capabilities, managing ignore lists, and joining channels. + This is a core Supybot plugin that should not be removed!""" def __init__(self, irc): self.__parent = super(Admin, self) self.__parent.__init__(irc) diff --git a/plugins/Aka/plugin.py b/plugins/Aka/plugin.py index 54f15ed06..c09a8d451 100644 --- a/plugins/Aka/plugin.py +++ b/plugins/Aka/plugin.py @@ -369,9 +369,9 @@ def findBiggestAt(alias): AkaDB = plugins.DB('Aka', available_db) class Aka(callbacks.Plugin): - """Aka is improved version of the Alias plugin. It stores akas outside - of the bot.conf and doesn't have risk of corrupting the bot.conf file - which often happens when there are Unicode issues. Aka also + """Aka is the improved version of the Alias plugin. It stores akas outside + of the bot.conf, which doesn't have risk of corrupting the bot.conf file + (this often happens when there are Unicode issues). Aka also introduces multi-worded akas.""" def __init__(self, irc): diff --git a/plugins/Alias/plugin.py b/plugins/Alias/plugin.py index 618b44706..e2f8cbbdf 100644 --- a/plugins/Alias/plugin.py +++ b/plugins/Alias/plugin.py @@ -231,6 +231,8 @@ def makeNewAlias(name, alias): return f class Alias(callbacks.Plugin): + """This plugin allows users to define aliases to commands and combinations + of commands (via nesting).""" def __init__(self, irc): self.__parent = super(Alias, self) self.__parent.__init__(irc) diff --git a/plugins/AutoMode/plugin.py b/plugins/AutoMode/plugin.py index cddcd4f10..01cf7fa06 100644 --- a/plugins/AutoMode/plugin.py +++ b/plugins/AutoMode/plugin.py @@ -45,6 +45,8 @@ class Continue(Exception): pass # Used below, look in the "do" function nested in doJoin. class AutoMode(callbacks.Plugin): + """This plugin, when configured, allows the bot to automatically set modes + on users when they join.""" def doJoin(self, irc, msg): channel = msg.args[0] if ircutils.strEqual(irc.nick, msg.nick): diff --git a/plugins/Channel/plugin.py b/plugins/Channel/plugin.py index 1bb0f351f..c2b010bed 100644 --- a/plugins/Channel/plugin.py +++ b/plugins/Channel/plugin.py @@ -43,6 +43,9 @@ from supybot.i18n import PluginInternationalization, internationalizeDocstring _ = PluginInternationalization('Channel') class Channel(callbacks.Plugin): + """This plugin provides various commands for channel management, such + as setting modes and channel-wide bans/ignores/capabilities. This is + a core Supybot plugin that should not be removed!""" def __init__(self, irc): self.__parent = super(Channel, self) self.__parent.__init__(irc) diff --git a/plugins/ChannelLogger/plugin.py b/plugins/ChannelLogger/plugin.py index c2d2488a7..b3fe10aa8 100644 --- a/plugins/ChannelLogger/plugin.py +++ b/plugins/ChannelLogger/plugin.py @@ -55,6 +55,7 @@ class FakeLog(object): return class ChannelLogger(callbacks.Plugin): + """This plugin allows the bot to log channel conversations to disk.""" noIgnore = True def __init__(self, irc): self.__parent = super(ChannelLogger, self) diff --git a/plugins/ChannelStats/plugin.py b/plugins/ChannelStats/plugin.py index fde2c3448..2dee17b4d 100644 --- a/plugins/ChannelStats/plugin.py +++ b/plugins/ChannelStats/plugin.py @@ -164,6 +164,8 @@ class StatsDB(plugins.ChannelUserDB): filename = conf.supybot.directories.data.dirize('ChannelStats.db') class ChannelStats(callbacks.Plugin): + """This plugin keeps stats of the channel and returns them with + the command 'channelstats'.""" noIgnore = True def __init__(self, irc): self.__parent = super(ChannelStats, self) diff --git a/plugins/Conditional/plugin.py b/plugins/Conditional/plugin.py index ecba0ff01..1433e7dc7 100644 --- a/plugins/Conditional/plugin.py +++ b/plugins/Conditional/plugin.py @@ -54,8 +54,9 @@ else: _all = __builtins__.all class Conditional(callbacks.Plugin): - """Add the help for "@plugin help Conditional" here - This should describe *how* to use this plugin.""" + """This plugin provides logic operators and other commands that + enable you to run commands only if a condition is true. Useful for nested + commands and scripting.""" threaded = True def __init__(self, irc): callbacks.Plugin.__init__(self, irc) diff --git a/plugins/Config/plugin.py b/plugins/Config/plugin.py index ac0f81c5e..7c20a7e73 100644 --- a/plugins/Config/plugin.py +++ b/plugins/Config/plugin.py @@ -111,6 +111,8 @@ def getSettableConfigVar(irc, msg, args, state): addConverter('settableConfigVar', getSettableConfigVar) class Config(callbacks.Plugin): + """Provides access to the Supybot configuration. This is + a core Supybot plugin that should not be removed!""" def callCommand(self, command, irc, msg, *args, **kwargs): try: super(Config, self).callCommand(command, irc, msg, *args, **kwargs) diff --git a/plugins/Ctcp/plugin.py b/plugins/Ctcp/plugin.py index 56a17190b..57c06db80 100644 --- a/plugins/Ctcp/plugin.py +++ b/plugins/Ctcp/plugin.py @@ -40,6 +40,8 @@ from supybot.i18n import PluginInternationalization, internationalizeDocstring _ = PluginInternationalization('Ctcp') class Ctcp(callbacks.PluginRegexp): + """Provides replies to common CTCPs (version, time, etc.), and a command + to fetch version responses from channels.""" public = False regexps = ('ctcpPing', 'ctcpVersion', 'ctcpUserinfo', 'ctcpTime', 'ctcpFinger', 'ctcpSource') diff --git a/plugins/Dict/plugin.py b/plugins/Dict/plugin.py index 9e5ec6f84..ba6884556 100644 --- a/plugins/Dict/plugin.py +++ b/plugins/Dict/plugin.py @@ -43,6 +43,8 @@ import random from local import dictclient class Dict(callbacks.Plugin): + """This plugin provides a function to look up words from different + dictionaries.""" threaded = True @internationalizeDocstring def dictionaries(self, irc, msg, args):