doc: Document log plugin

diff --git a/doc/source/plugins.rst b/doc/source/plugins.rst
index 1d74032006a54f8e6b75cd3149344ffd449860b3..cd0aa26458d5b0d94c46e55a51550976c8693d0a 100644 (file)
--- 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 746fad2f08c2eedf5694da6dd80be68d1b3b18f8..f3f45e707af4bcef5611a4ffebf5c02927d1a7bd 100644 (file)
--- 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())