Reformat docstrings to have nice help message

[sid.git] / sid / log.py

diff --git a/sid/log.py b/sid/log.py
index e97e738f4734bd32d4e96fdf06fba6b937c579ee..278be3d505ebbe63d7dbdfcbe108eec57b1dbf66 100644 (file)
--- a/sid/log.py
+++ b/sid/log.py
@@ -23,7 +23,7 @@ from .plugin import Plugin, botcmd
 
 
 class Log(Plugin):
-    """Logs presence.
+    """Logs group chat participant presence.
 
     The account running the bot need at least room moderation right to log
     participants JIDs (fallback to nickname).
@@ -70,8 +70,9 @@ class Log(Plugin):
 
     @botcmd(hidden=True)
     def write(self, message, args):
-        """
-        **command** (hidden) ``!write`` : Writes log to file (use mktemp and return file location as MUC message)"""
+        """Dump/save room presences log
+
+        ``!write`` : Writes log to file (use mktemp and return file location as MUC message)"""
         delay = int(time()) - Log.throttle_ts
         if delay < 30:
             self.log.debug('throttling file creation')
@@ -89,7 +90,7 @@ class Log(Plugin):
 
     @botcmd(hidden=True)
     def dump(self, message, args):
-        """**command** (hidden)  ``!dump``  : Dumps log as MUC message"""
+        """``!dump``  : Dumps log as MUC message"""
         self.reply(message, self._format_log())