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).
@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')
@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())