mirror of
https://github.com/Mikaela/Limnoria.git
synced 2024-12-23 11:12:47 +01:00
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.
This commit is contained in:
parent
3e783a96a6
commit
74655e4203
@ -43,6 +43,9 @@ from supybot.i18n import PluginInternationalization, internationalizeDocstring
|
|||||||
_ = PluginInternationalization('Admin')
|
_ = PluginInternationalization('Admin')
|
||||||
|
|
||||||
class Admin(callbacks.Plugin):
|
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):
|
def __init__(self, irc):
|
||||||
self.__parent = super(Admin, self)
|
self.__parent = super(Admin, self)
|
||||||
self.__parent.__init__(irc)
|
self.__parent.__init__(irc)
|
||||||
|
@ -369,9 +369,9 @@ def findBiggestAt(alias):
|
|||||||
AkaDB = plugins.DB('Aka', available_db)
|
AkaDB = plugins.DB('Aka', available_db)
|
||||||
|
|
||||||
class Aka(callbacks.Plugin):
|
class Aka(callbacks.Plugin):
|
||||||
"""Aka is improved version of the Alias plugin. It stores akas outside
|
"""Aka is the 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
|
of the bot.conf, which doesn't have risk of corrupting the bot.conf file
|
||||||
which often happens when there are Unicode issues. Aka also
|
(this often happens when there are Unicode issues). Aka also
|
||||||
introduces multi-worded akas."""
|
introduces multi-worded akas."""
|
||||||
|
|
||||||
def __init__(self, irc):
|
def __init__(self, irc):
|
||||||
|
@ -231,6 +231,8 @@ def makeNewAlias(name, alias):
|
|||||||
return f
|
return f
|
||||||
|
|
||||||
class Alias(callbacks.Plugin):
|
class Alias(callbacks.Plugin):
|
||||||
|
"""This plugin allows users to define aliases to commands and combinations
|
||||||
|
of commands (via nesting)."""
|
||||||
def __init__(self, irc):
|
def __init__(self, irc):
|
||||||
self.__parent = super(Alias, self)
|
self.__parent = super(Alias, self)
|
||||||
self.__parent.__init__(irc)
|
self.__parent.__init__(irc)
|
||||||
|
@ -45,6 +45,8 @@ class Continue(Exception):
|
|||||||
pass # Used below, look in the "do" function nested in doJoin.
|
pass # Used below, look in the "do" function nested in doJoin.
|
||||||
|
|
||||||
class AutoMode(callbacks.Plugin):
|
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):
|
def doJoin(self, irc, msg):
|
||||||
channel = msg.args[0]
|
channel = msg.args[0]
|
||||||
if ircutils.strEqual(irc.nick, msg.nick):
|
if ircutils.strEqual(irc.nick, msg.nick):
|
||||||
|
@ -43,6 +43,9 @@ from supybot.i18n import PluginInternationalization, internationalizeDocstring
|
|||||||
_ = PluginInternationalization('Channel')
|
_ = PluginInternationalization('Channel')
|
||||||
|
|
||||||
class Channel(callbacks.Plugin):
|
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):
|
def __init__(self, irc):
|
||||||
self.__parent = super(Channel, self)
|
self.__parent = super(Channel, self)
|
||||||
self.__parent.__init__(irc)
|
self.__parent.__init__(irc)
|
||||||
|
@ -55,6 +55,7 @@ class FakeLog(object):
|
|||||||
return
|
return
|
||||||
|
|
||||||
class ChannelLogger(callbacks.Plugin):
|
class ChannelLogger(callbacks.Plugin):
|
||||||
|
"""This plugin allows the bot to log channel conversations to disk."""
|
||||||
noIgnore = True
|
noIgnore = True
|
||||||
def __init__(self, irc):
|
def __init__(self, irc):
|
||||||
self.__parent = super(ChannelLogger, self)
|
self.__parent = super(ChannelLogger, self)
|
||||||
|
@ -164,6 +164,8 @@ class StatsDB(plugins.ChannelUserDB):
|
|||||||
|
|
||||||
filename = conf.supybot.directories.data.dirize('ChannelStats.db')
|
filename = conf.supybot.directories.data.dirize('ChannelStats.db')
|
||||||
class ChannelStats(callbacks.Plugin):
|
class ChannelStats(callbacks.Plugin):
|
||||||
|
"""This plugin keeps stats of the channel and returns them with
|
||||||
|
the command 'channelstats'."""
|
||||||
noIgnore = True
|
noIgnore = True
|
||||||
def __init__(self, irc):
|
def __init__(self, irc):
|
||||||
self.__parent = super(ChannelStats, self)
|
self.__parent = super(ChannelStats, self)
|
||||||
|
@ -54,8 +54,9 @@ else:
|
|||||||
_all = __builtins__.all
|
_all = __builtins__.all
|
||||||
|
|
||||||
class Conditional(callbacks.Plugin):
|
class Conditional(callbacks.Plugin):
|
||||||
"""Add the help for "@plugin help Conditional" here
|
"""This plugin provides logic operators and other commands that
|
||||||
This should describe *how* to use this plugin."""
|
enable you to run commands only if a condition is true. Useful for nested
|
||||||
|
commands and scripting."""
|
||||||
threaded = True
|
threaded = True
|
||||||
def __init__(self, irc):
|
def __init__(self, irc):
|
||||||
callbacks.Plugin.__init__(self, irc)
|
callbacks.Plugin.__init__(self, irc)
|
||||||
|
@ -111,6 +111,8 @@ def getSettableConfigVar(irc, msg, args, state):
|
|||||||
addConverter('settableConfigVar', getSettableConfigVar)
|
addConverter('settableConfigVar', getSettableConfigVar)
|
||||||
|
|
||||||
class Config(callbacks.Plugin):
|
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):
|
def callCommand(self, command, irc, msg, *args, **kwargs):
|
||||||
try:
|
try:
|
||||||
super(Config, self).callCommand(command, irc, msg, *args, **kwargs)
|
super(Config, self).callCommand(command, irc, msg, *args, **kwargs)
|
||||||
|
@ -40,6 +40,8 @@ from supybot.i18n import PluginInternationalization, internationalizeDocstring
|
|||||||
_ = PluginInternationalization('Ctcp')
|
_ = PluginInternationalization('Ctcp')
|
||||||
|
|
||||||
class Ctcp(callbacks.PluginRegexp):
|
class Ctcp(callbacks.PluginRegexp):
|
||||||
|
"""Provides replies to common CTCPs (version, time, etc.), and a command
|
||||||
|
to fetch version responses from channels."""
|
||||||
public = False
|
public = False
|
||||||
regexps = ('ctcpPing', 'ctcpVersion', 'ctcpUserinfo',
|
regexps = ('ctcpPing', 'ctcpVersion', 'ctcpUserinfo',
|
||||||
'ctcpTime', 'ctcpFinger', 'ctcpSource')
|
'ctcpTime', 'ctcpFinger', 'ctcpSource')
|
||||||
|
@ -43,6 +43,8 @@ import random
|
|||||||
from local import dictclient
|
from local import dictclient
|
||||||
|
|
||||||
class Dict(callbacks.Plugin):
|
class Dict(callbacks.Plugin):
|
||||||
|
"""This plugin provides a function to look up words from different
|
||||||
|
dictionaries."""
|
||||||
threaded = True
|
threaded = True
|
||||||
@internationalizeDocstring
|
@internationalizeDocstring
|
||||||
def dictionaries(self, irc, msg, args):
|
def dictionaries(self, irc, msg, args):
|
||||||
|
Loading…
Reference in New Issue
Block a user