Switch comments of callbacks.PluginRegexp's attributes to docstrings (for Sphinx).

This commit is contained in:
Valentin Lorentz 2014-01-21 13:43:33 +01:00
parent a5e06e1b57
commit e1f9d68870

View File

@ -1411,15 +1411,15 @@ class PluginRegexp(Plugin):
the bot is addressed, or triggered only when the bot isn't addressed.
"""
flags = re.I
# 'regexps' methods are called whether the message is addressed or not.
regexps = ()
# 'addressedRegexps' methods are called only when the message is addressed,
# and then, only with the payload (i.e., what is returned from the
# 'addressed' function.
"""'regexps' methods are called whether the message is addressed or not."""
addressedRegexps = ()
# 'unaddressedRegexps' methods are called only when the message is *not*
# addressed.
"""'addressedRegexps' methods are called only when the message is addressed,
and then, only with the payload (i.e., what is returned from the
'addressed' function."""
unaddressedRegexps = ()
"""'unaddressedRegexps' methods are called only when the message is *not*
addressed."""
Proxy = SimpleProxy
def __init__(self, irc):
self.__parent = super(PluginRegexp, self)