Merge pull request #924 from GLolol/plugin-help-1

Add help for plugins from A-D (batch 1)
This commit is contained in:
Valentin Lorentz 2014-11-30 10:14:24 +01:00
commit 24b1d2dc9c
11 changed files with 25 additions and 5 deletions

View File

@ -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)

View File

@ -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):

View File

@ -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)

View File

@ -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):

View File

@ -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)

View File

@ -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)

View File

@ -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)

View File

@ -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)

View File

@ -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)

View File

@ -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')

View File

@ -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):