changeset 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 6d0e01809893
files src/plugins/plugin_misc_text_commands.py
diffstat 1 files changed, 11 insertions(+), 2 deletions(-) [+]
line wrap: on
line diff
--- a/src/plugins/plugin_misc_text_commands.py	Thu Mar 19 14:30:08 2015 +0100
+++ b/src/plugins/plugin_misc_text_commands.py	Thu Mar 19 14:38:02 2015 +0100
@@ -271,7 +271,12 @@
         self.host.bridge.newMessage(unicode(mess_data["to"]), message, C.MESS_TYPE_INFO, unicode(_from), {}, profile=profile)
 
     def cmd_whois(self, mess_data, profile):
-        """show information on entity"""
+        """show informations on entity
+
+        @command: [JID|ROOM_NICK]
+            - JID: entity to request
+            - ROOM_NICK: nick of the room to request
+        """
         log.debug("Catched whois command")
 
         entity = mess_data["unparsed"].strip()
@@ -367,6 +372,10 @@
         self.feedBack(help_mess, mess_data, profile)
 
     def cmd_me(self, mess_data, profile):
-        """Display a message at third person"""
+        """Display a message at third person
+
+        @command: message
+            - message: message to display at the third person
+        """
         # We just catch the method and continue it as the frontends should manage /me display
         return True