From 7755536da1a7be8684bb4cfc2b563e8ae80362f4 Mon Sep 17 00:00:00 2001
From: fspitzba <fspitzba@hs-mittweida.de>
Date: Thu, 15 Oct 2020 20:39:02 +0200
Subject: [PATCH] [COMMENT] Added Code Comments

---
 HSMensaW_botA.py | 46 +++++++++++++++++++++++++++++++++++-----------
 1 file changed, 35 insertions(+), 11 deletions(-)

diff --git a/HSMensaW_botA.py b/HSMensaW_botA.py
index 1222bff..ab01746 100644
--- a/HSMensaW_botA.py
+++ b/HSMensaW_botA.py
@@ -4,7 +4,8 @@
 # since 3.5: type hints 
 # def <name>(<args) -> <returntype>:
 
-import asyncio # write concurrent code (not threading. not multiprocessing)
+import asyncio
+# write concurrent code (not threading. not multiprocessing)
 # it's cooperative multitasking, no parallelism
 # coroutines: suspend execution before return and pass control to another coroutine
 # use await only in async functions
@@ -34,13 +35,34 @@ from telepot.namedtuple import InlineKeyboardMarkup, InlineKeyboardButton
 
 
 class Essen:
-    """ Test Docstring """
-    def __init__(self, name, preis, kategorie):
+    """Class which represents a Essen-Object"""
+    def __init__(self, name, preis, kategorie) -> None:
+        """
+        Initialize a Essen-Object with given values
+            
+            Parameters:
+                name (string): name of the meal 
+                preis (float): price of the meal
+                kategorie (string): category of the meal
+
+            Returns:
+                None
+        """
         self.name = name
         self.preis = preis
         self.kategorie = kategorie
+        return None
 
-    def __str__(self):
+    def __str__(self) -> str:
+        """
+        Formats the attribute of the Essen-Object to a string
+
+            Parameters:
+                None
+
+            Returns:
+                _ (string): formatted String of attributes
+        """
         if self.preis > 0:
             return str("*%s*: `%s` (%.2f €)" % (self.kategorie, self.name, self.preis))
         else:
@@ -54,13 +76,15 @@ class Language(Enum):
 
 
 config_filename = "config.json"
-info_str = "*Inoffizieller Mensa-Bot der Hochschule Mittweida*\nDieser Bot versendet jeden Tag um 10 Uhr den aktuellen " \
-           "Mensa-Speiseplan. Er wird über /start für den aktuellen Chat oder die aktuelle Gruppe gestartet, " \
-           "/stop beendet ihn wieder. Mit /essen, /mensa und /speiseplan (optional gefolgt von _en_ oder _de_) kann " \
-           "der aktuelle Speiseplan manuell abgerufen werden. Mit /settings kann (von Gruppenadmins) die Sprache " \
-           "verändert werden.\n\n_Haftungsausschluss: Dieser Bot steht in keiner Verbindung mit der Hochschule " \
-           "Mittweida oder dem Studentenwerk Freiberg. Alle Angaben ohne Gewähr._\n\nGrafik bereitgestellt von [" \
-           "vecteezy.com](https://de.vecteezy.com) "
+info_str = '''
+            *Inoffizieller Mensa-Bot der Hochschule Mittweida*\nDieser Bot versendet jeden Tag um 10 Uhr den aktuellen
+            Mensa-Speiseplan. Er wird über /start für den aktuellen Chat oder die aktuelle Gruppe gestartet,
+            /stop beendet ihn wieder. Mit /essen, /mensa und /speiseplan (optional gefolgt von _en_ oder _de_) kann
+            der aktuelle Speiseplan manuell abgerufen werden. Mit /settings kann (von Gruppenadmins) die Sprache
+            verändert werden.\n\n_Haftungsausschluss: Dieser Bot steht in keiner Verbindung mit der Hochschule 
+            Mittweida oder dem Studentenwerk Freiberg. Alle Angaben ohne Gewähr._\n\nGrafik bereitgestellt von [
+            vecteezy.com](https://de.vecteezy.com)
+           '''
 status = ""
 essen = []
 essen_eng = []