From: kaliko <kaliko@azylum.org>
Date: Wed, 13 May 2020 09:01:04 +0000 (+0200)
Subject: doc: Document log plugin
X-Git-Tag: 0.1.0~4
X-Git-Url: https://git.kaliko.me/?p=sid.git;a=commitdiff_plain;h=b11971d184420bc764aa767664c1239e03c9ba25

doc: Document log plugin
---

diff --git a/doc/source/plugins.rst b/doc/source/plugins.rst
index 1d74032..cd0aa26 100644
--- a/doc/source/plugins.rst
+++ b/doc/source/plugins.rst
@@ -12,6 +12,10 @@ Generic plugins
     :members:
     :show-inheritance:
 
+.. automodule:: sid.log
+    :members:
+    :show-inheritance:
+
 Debian plugins
 --------------
 
diff --git a/sid/log.py b/sid/log.py
index 746fad2..f3f45e7 100644
--- a/sid/log.py
+++ b/sid/log.py
@@ -68,7 +68,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 +86,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())