X-Git-Url: https://git.kaliko.me/?a=blobdiff_plain;f=sid%2Flog.py;h=278be3d505ebbe63d7dbdfcbe108eec57b1dbf66;hb=HEAD;hp=746fad2f08c2eedf5694da6dd80be68d1b3b18f8;hpb=55a4c77646865cd41014311e0efd86392ca4b5d5;p=sid.git

diff --git a/sid/log.py b/sid/log.py
index 746fad2..1872c1b 100644
--- a/sid/log.py
+++ b/sid/log.py
@@ -1,18 +1,6 @@
 # -*- coding: utf-8 -*-
-
-# Copyright (C) 2020 kaliko <kaliko@azylum.org>
-
-# This program is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, version 3 only.
-
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-
-# You should have received a copy of the GNU General Public License
-# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+# SPDX-FileCopyrightText: 2020 kaliko <kaliko@azylum.org>
+# SPDX-License-Identifier: GPL-3.0-or-later
 
 from datetime import datetime
 from os import fdopen
@@ -23,7 +11,10 @@ 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).
     """
     throttle_ts = int(time())-30
 
@@ -67,8 +58,9 @@ class Log(Plugin):
 
     @botcmd(hidden=True)
     def write(self, message, args):
-        """
-        **command** ``!write`` : Write log to file"""
+        """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')
@@ -86,7 +78,7 @@ class Log(Plugin):
 
     @botcmd(hidden=True)
     def dump(self, message, args):
-        """**command**  ``!dump``  : dump log online!"""
+        """``!dump``  : Dumps log as MUC message"""
         self.reply(message, self._format_log())