comparison src/plugins/plugin_misc_text_commands.py @ 1372:85caf0a3abb3

plugin text commands: minor docstrings improvments
author Goffi <goffi@goffi.org>
date Thu, 19 Mar 2015 14:38:02 +0100
parents 876c9fbd0b3d
children 069ad98b360d
comparison
equal deleted inserted replaced
1371:876c9fbd0b3d 1372:85caf0a3abb3
269 _from = self.host.getJidNStream(profile)[0] 269 _from = self.host.getJidNStream(profile)[0]
270 270
271 self.host.bridge.newMessage(unicode(mess_data["to"]), message, C.MESS_TYPE_INFO, unicode(_from), {}, profile=profile) 271 self.host.bridge.newMessage(unicode(mess_data["to"]), message, C.MESS_TYPE_INFO, unicode(_from), {}, profile=profile)
272 272
273 def cmd_whois(self, mess_data, profile): 273 def cmd_whois(self, mess_data, profile):
274 """show information on entity""" 274 """show informations on entity
275
276 @command: [JID|ROOM_NICK]
277 - JID: entity to request
278 - ROOM_NICK: nick of the room to request
279 """
275 log.debug("Catched whois command") 280 log.debug("Catched whois command")
276 281
277 entity = mess_data["unparsed"].strip() 282 entity = mess_data["unparsed"].strip()
278 283
279 if mess_data['type'] == "groupchat": 284 if mess_data['type'] == "groupchat":
365 args_help=u'\n'.join([u" "*8+"{}".format(line) for line in self._getArgsHelp(cmd_data)])) 370 args_help=u'\n'.join([u" "*8+"{}".format(line) for line in self._getArgsHelp(cmd_data)]))
366 371
367 self.feedBack(help_mess, mess_data, profile) 372 self.feedBack(help_mess, mess_data, profile)
368 373
369 def cmd_me(self, mess_data, profile): 374 def cmd_me(self, mess_data, profile):
370 """Display a message at third person""" 375 """Display a message at third person
376
377 @command: message
378 - message: message to display at the third person
379 """
371 # We just catch the method and continue it as the frontends should manage /me display 380 # We just catch the method and continue it as the frontends should manage /me display
372 return True 381 return True