From ccd695c462386244310d45ef58834f5e71854681 Mon Sep 17 00:00:00 2001 From: manetta Date: Sun, 7 Mar 2021 10:50:48 +0100 Subject: [PATCH] adding descriptions to all the functions --- LogBot/logbot.py | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/LogBot/logbot.py b/LogBot/logbot.py index d8dfaf1..d07e039 100644 --- a/LogBot/logbot.py +++ b/LogBot/logbot.py @@ -53,6 +53,7 @@ class Logbot(Bot): ) def _download(self, message): + """Download media files.""" # define media_type if message.url.lower().endswith(self.IMAGE_TYPES): media_type = "images" @@ -153,6 +154,7 @@ class Logbot(Bot): self.log.info(f"Copied stylesheet.css to: { room }") def setup(self): + """Setup a log for all the rooms LogBot is subscribed to.""" self.log.info(f"Output folder is set to: { self.output }") for room in self.rooms: self._setup_room(room) @@ -165,8 +167,7 @@ class Logbot(Bot): self._setup_room(str(message["from"])) def group(self, message): - - # to debug in the terminal + """All the things LogBot does when it receives a group message.""" self.log.info("------------------") self.log.info(f"message: {message.text}") self.log.info(f"room: {message.room}")