From b11971d184420bc764aa767664c1239e03c9ba25 Mon Sep 17 00:00:00 2001 From: kaliko Date: Wed, 13 May 2020 11:01:04 +0200 Subject: [PATCH] doc: Document log plugin --- doc/source/plugins.rst | 4 ++++ sid/log.py | 4 ++-- 2 files changed, 6 insertions(+), 2 deletions(-) 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()) -- 2.39.2