From 46491d39843d68aa9b7a38dea2bf80b269be9d1d Mon Sep 17 00:00:00 2001
From: Marcel Schwarz <marcel@icaotix.de>
Date: Sat, 21 Mar 2020 22:51:22 +0100
Subject: [PATCH] Add documentation for class and show_logs

---
 modules/teamspeak/Teamspeak.py | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/modules/teamspeak/Teamspeak.py b/modules/teamspeak/Teamspeak.py
index 63d1863..294bb2c 100644
--- a/modules/teamspeak/Teamspeak.py
+++ b/modules/teamspeak/Teamspeak.py
@@ -5,6 +5,7 @@ import re
 
 
 class Teamspeak:
+    """Manage a Docker backed Teamspeak server"""
 
     def start(self):
         """Starts a Teamspeak Server with docker-compose"""
@@ -27,4 +28,5 @@ class Teamspeak:
         subprocess.run(f"tar -zcvf {name} ts3_data", shell=True, cwd=path.dirname(__file__))
 
     def show_logs(self):
+        """show the logs of the running Teamspeak server"""
         subprocess.run("docker-compose logs", shell=True, cwd=path.dirname(__file__))