From 497ffd80c810f6a15713a56825ddab45a3cecb6a Mon Sep 17 00:00:00 2001
From: adamercat <adamercat@posteo.be>
Date: Fri, 18 Dec 2020 15:00:54 +0100
Subject: [PATCH] Added Docstrings and corrected for style.

---
 user_interface.py | 41 ++++++++++++++++++++++++++++++-----------
 1 file changed, 30 insertions(+), 11 deletions(-)

diff --git a/user_interface.py b/user_interface.py
index 60a77d5..0a04e7d 100644
--- a/user_interface.py
+++ b/user_interface.py
@@ -1,11 +1,18 @@
-"""user interface"""
+"""This module has all the building blocks for a nice 16-is-dead user interface"""
+
+__author__ = ""
+__credits__ = ""
+__email__ = ""
 
 import time
 import os
 
 
-
 def dice_animation():
+    '''
+    This functions prints the rolling dice animation
+    return: None
+    '''
     for i in range(4):
         plz_print('dice_animation1.txt')
         time.sleep(0.25)
@@ -16,6 +23,11 @@ def dice_animation():
 
 
 def plz_print(filename):
+    '''
+    This functions reads a file line by line
+    and prints it in on call.
+    return: None
+    '''
     with open(filename, 'r', encoding='utf8') as f:
         bigstring = ""
         for line in f:
@@ -24,12 +36,23 @@ def plz_print(filename):
 
 
 def clear():
+    '''
+    This functions clears the terminal screen,
+    it distinguishes between Linux and Windows
+    But it does not work in pycharm or idle.
+    return: None
+    '''
     if os.name == 'nt':  # for windows
         os.system('cls')
     else:  # for linux, mac
         os.system('clear')
 
+
 def pling(current_roll):
+    '''
+    This functions prints the animation of the dice result
+    return: None
+    '''
     with open('pling_animation', 'r', encoding='utf8') as f:
         big_string = ""
         animations = []
@@ -42,22 +65,18 @@ def pling(current_roll):
 
         dice_result = animations[current_roll[0] - 1]
         for line in dice_result:
-            scan_lines += line 
+            scan_lines += line
             if line[0] == '#':
                 clear()
                 print(scan_lines[:-2])
                 time.sleep(0.5)
                 scan_lines = ""
 
-        #for item in animations:
-            #print(item)
-            #print('------------------------------------')
 
 def the_end():
+    '''
+    This functions prints the end screen.
+    return: None
+    '''
     print("--------------------------\n\/\/\/\ SPIEL ENDE /\/\/\/\n--------------------------")
-                               
 
-#dice_animation()
-#for i in range(1,7):
-    #pling(i)
-#the_end()