From 5f8e45aaa8e69ca6753fd980e90b458104231d33 Mon Sep 17 00:00:00 2001 From: Valentin Lorentz Date: Fri, 21 Mar 2014 15:31:48 +0000 Subject: [PATCH] Fix doc of NestedCommandsIrcProxy.reply. --- src/callbacks.py | 24 +++++++++++++----------- 1 file changed, 13 insertions(+), 11 deletions(-) diff --git a/src/callbacks.py b/src/callbacks.py index adf288a14..9229ca7c7 100644 --- a/src/callbacks.py +++ b/src/callbacks.py @@ -837,19 +837,21 @@ class NestedCommandsIrcProxy(ReplyIrcProxy): def reply(self, s, noLengthCheck=False, prefixNick=None, action=None, private=None, notice=None, to=None, msg=None): - """reply(s) -> replies to msg with s + """ + + reply(s) -> replies to msg with s Keyword arguments: - noLengthCheck=False: True if the length shouldn't be checked - (used for 'more' handling) - prefixNick=True: False if the nick shouldn't be prefixed to the - reply. - action=False: True if the reply should be an action. - private=False: True if the reply should be in private. - notice=False: True if the reply should be noticed when the - bot is configured to do so. - to=: The nick or channel the reply should go to. - Defaults to msg.args[0] (or msg.nick if private) + * `noLengthCheck=False`: True if the length shouldn't be checked + (used for 'more' handling) + * `prefixNick=True`: False if the nick shouldn't be prefixed to the + reply. + * `action=False`: True if the reply should be an action. + * `private=False`: True if the reply should be in private. + * `notice=False`: True if the reply should be noticed when the + bot is configured to do so. + * `to=`: The nick or channel the reply should go to. + Defaults to msg.args[0] (or msg.nick if private) """ # These use and or or based on whether or not they default to True or # False. Those that default to True use and; those that default to