changeset 2691:64eae2cfb6dc

Improve comment.
author Karol Nowak <grzywacz@sul.uni.lodz.pl>
date Fri, 17 Aug 2007 04:29:52 +0200
parents 248a1ff78c24
children 42eaeb7584d0
files jabberbot/xmlrpcbot.py
diffstat 1 files changed, 8 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/jabberbot/xmlrpcbot.py	Fri Aug 17 04:27:44 2007 +0200
+++ b/jabberbot/xmlrpcbot.py	Fri Aug 17 04:29:52 2007 +0200
@@ -134,6 +134,14 @@
             self.do_revert(command)
 
     def report_error(self, jid, text, data={}):
+        """Reports an internal error
+
+        @param jid: Jabber ID that should be informed about the error condition
+        @param text: description of the error
+        @param data: dictionary used to substitute strings in translated message
+        @type data: dict
+
+        """
         # Dummy function, so that the string appears in a .po file
         _ = lambda x: x