fix typo

tsgrain_controller/application.py

@@ -176,6 +176,7 @@ class Application(models.AppInterface):
         systimecfg.set_system_timezone(tz, self.cfg.cmd_set_timezone)
 
     def start(self):
+        """Starte die Anwendung"""
         logging.info('Starting application')
         self._running = True
         self.io.start()
@@ -185,6 +186,7 @@ class Application(models.AppInterface):
         self.grpc_server.start()
 
     def stop(self):
+        """Stoppe die Anwendung"""
         logging.info('Stopping application')
         self._running = False
         self.grpc_server.stop(None)

tsgrain_controller/io/mcp23017.py

@@ -238,7 +238,7 @@ class _MCP23017Device:
         Beispiel: ``0x27/B0`` (MCP23017 mit I2C-Adresse 0x27, Pin B0)
 
         Um den Zustand eines Geräts zu invertieren, einfach ``/!``
-        an den Konfiguraionsstring anfügen: ``0x27/B0/!``
+        an den Konfigurationsstring anfügen: ``0x27/B0/!``
 
         :param cfg_str: Konfigurationsstring
         :return: Neues ``_MCP23017Device``-Objekt

tsgrain_controller/models.py

@@ -51,10 +51,10 @@ class Job:
                    and date_now.minute == self.date.minute
 
         return date_now.year == self.date.year \
-                   and date_now.month == self.date.month \
-                   and date_now.day == self.date.day \
-                   and date_now.hour == self.date.hour \
-                   and date_now.minute == self.date.minute
+               and date_now.month == self.date.month \
+               and date_now.day == self.date.day \
+               and date_now.hour == self.date.hour \
+               and date_now.minute == self.date.minute
 
     def serialize(self) -> Dict[str, Any]:
         return {
@@ -96,6 +96,10 @@ class Job:
         )
 
     def validate(self, app: 'AppInterface'):
+        """
+        Prüfe, ob der Task gültige Daten enthält
+        (Zonen existieren, Bewässerungszeit > 0)
+        """
         if not self.zones:
             raise util.InvalidInputException('No zones set')
         if self.duration < 1:
@@ -309,7 +313,7 @@ class AppInterface:
 
         :param request: Objekt, dass die Parameter der neuen Aufgabe enthält.
         :return: Statusobjekt (Information, ob eine Aufgabe gestartet oder gestoppt
-        wurde).
+          wurde).
         """
 
     def start_task(self, source: Source, zone_id: int, duration: int,
@@ -321,7 +325,7 @@ class AppInterface:
         :param zone_id: ID der Bewässerungszone
         :param duration: Bewässerungsdauer in Sekunden (0 für Standarddauer)
         :param queuing: Neue Aufgabe in die Warteschlange einreihen, wenn momentan
-        eine andere Zone bewässert wird.
+          eine andere Zone bewässert wird.
         :return: True wenn die Aufgabe erfolgreich gestartet wurde
         """
 

tsgrain_controller/task_queue.py

@@ -28,7 +28,7 @@ class TaskQueue(util.StoppableThread, TaskHolder):
 
         :param task: Neuer Task
         :param queuing: Füge Task der Warteschlange hinzu, wenn bereits
-        ein anderer Task läuft
+          ein anderer Task läuft
         :return: True wenn Task erfolgreich hinzugefügt
         """
         if not queuing and self.running_task is not None:

tsgrain_controller/util.py

@@ -129,9 +129,20 @@ class StoppableThread(threading.Thread):
         pass
 
     def run_cycle(self):
-        pass
+        """
+        Führe einen Durchlauf des Threads aus.
+
+        Diese Funktion darf nicht blockieren, sonst kann der
+        Thread nicht gestoppt werden.
+        """
 
     def run(self):
+        """
+        Führe die ``run_cycle()``-Funktion in
+        Endlosschleife aus, mit einer durch das
+        ``interval``-Attribut bestimmten Verzögerung zwischen
+        den Durchläufen.
+        """
         try:
             self.setup()
 
@@ -146,6 +157,10 @@ class StoppableThread(threading.Thread):
             sys.excepthook(*sys.exc_info())
 
     def stop(self):
+        """
+        Stoppe den Thread und warte bis er beendet. Dies dauert
+        maximal ``interval`` + Durchlaufzeit von ``run_cycle()``.
+        """
         self._stop_signal.set()
         try:
             self.join()