doc: Improved documentation

[sid.git] / sid / log.py

diff --git a/sid/log.py b/sid/log.py
index 746fad2f08c2eedf5694da6dd80be68d1b3b18f8..e97e738f4734bd32d4e96fdf06fba6b937c579ee 100644 (file)
--- a/sid/log.py
+++ b/sid/log.py
@@ -24,6 +24,9 @@ from .plugin import Plugin, botcmd
 
 class Log(Plugin):
     """Logs presence.
+
+    The account running the bot need at least room moderation right to log
+    participants JIDs (fallback to nickname).
     """
     throttle_ts = int(time())-30
 
@@ -68,7 +71,7 @@ class Log(Plugin):
     @botcmd(hidden=True)
     def write(self, message, args):
         """
-        **command** ``!write`` : Write log to file"""
+        **command** (hidden) ``!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')
@@ -86,7 +89,7 @@ class Log(Plugin):
 
     @botcmd(hidden=True)
     def dump(self, message, args):
-        """**command**  ``!dump``  : dump log online!"""
+        """**command** (hidden)  ``!dump``  : Dumps log as MUC message"""
         self.reply(message, self._format_log())