From a9631796cf6d03946c6d1a72fba3cff554bd0f5c Mon Sep 17 00:00:00 2001
From: Viljami Ilola <+@hix.fi>
Date: Fri, 29 Mar 2024 18:39:41 +0200
Subject: docstrings

---
 src/sliceitoff/screens/__init__.py | 2 ++
 src/sliceitoff/screens/gameover.py | 2 ++
 src/sliceitoff/screens/hiscores.py | 2 ++
 src/sliceitoff/screens/initials.py | 3 +++
 src/sliceitoff/screens/level.py    | 3 ++-
 src/sliceitoff/screens/levelup.py  | 3 ++-
 src/sliceitoff/screens/welcome.py  | 2 ++
 7 files changed, 15 insertions(+), 2 deletions(-)

(limited to 'src/sliceitoff/screens')

diff --git a/src/sliceitoff/screens/__init__.py b/src/sliceitoff/screens/__init__.py
index d448890..107d231 100644
--- a/src/sliceitoff/screens/__init__.py
+++ b/src/sliceitoff/screens/__init__.py
@@ -1,3 +1,5 @@
+""" screens - collection of functions that generates group of spites
+    to fill the screen """
 from .welcome import welcome_screen
 from .levelup import levelup_screen
 from .gameover import gameover_screen
diff --git a/src/sliceitoff/screens/gameover.py b/src/sliceitoff/screens/gameover.py
index 33bda18..aac4b22 100644
--- a/src/sliceitoff/screens/gameover.py
+++ b/src/sliceitoff/screens/gameover.py
@@ -1,6 +1,8 @@
+""" screen.gameover - screen to be displayer game over situation """
 from text import TextPage
 
 def gameover_screen():
+    """ gameover_screen - overlay top of ended gameplay """
     return TextPage(
             "Game Over!",
             font = '8x8',
diff --git a/src/sliceitoff/screens/hiscores.py b/src/sliceitoff/screens/hiscores.py
index 74a0ee2..c73f0bf 100644
--- a/src/sliceitoff/screens/hiscores.py
+++ b/src/sliceitoff/screens/hiscores.py
@@ -1,6 +1,8 @@
+""" screens.hiscores - Defines how to display hiscore text on the screen """
 from text import TextPage
 
 def hiscores_screen(score_text):
+    """ hiscores_screen - only ajustments to hiscore text """
     return TextPage(
             score_text,
             font = 'lcd',
diff --git a/src/sliceitoff/screens/initials.py b/src/sliceitoff/screens/initials.py
index aadb141..334f515 100644
--- a/src/sliceitoff/screens/initials.py
+++ b/src/sliceitoff/screens/initials.py
@@ -1,6 +1,9 @@
+""" screens.initials - screen where input initials when one makes
+    to hiscores """
 from text import TextPage
 
 def initials_screen(name):
+    """ initials_screen - screen where name is updating as user imputs """
     return TextPage(
             f" New High Score!\n"
             f"\n"
diff --git a/src/sliceitoff/screens/level.py b/src/sliceitoff/screens/level.py
index ea298ad..d3a60f8 100644
--- a/src/sliceitoff/screens/level.py
+++ b/src/sliceitoff/screens/level.py
@@ -1,7 +1,8 @@
+""" screens.level - Screen to be shown when level begins. """
 from text import TextPage
-from stats import Stats
 
 def level_screen(level):
+    """ level_screen - displays level number """
     return TextPage(
             f"Level {level}!",
             font = '8x8',
diff --git a/src/sliceitoff/screens/levelup.py b/src/sliceitoff/screens/levelup.py
index ef48b7b..25cb1b9 100644
--- a/src/sliceitoff/screens/levelup.py
+++ b/src/sliceitoff/screens/levelup.py
@@ -1,6 +1,8 @@
+""" screen.levelup - Screen to show after succesfully completing level """
 from text import TextPage
 
 def levelup_screen(stats = None):
+    """ levelup_screen - screen full of stats how bonus is calculated """
     (
             total_bonus,
             level_bonus,
@@ -20,7 +22,6 @@ def levelup_screen(stats = None):
             f"\xea\x0f\xef{herd_bonus:9d}pts\n"
             f"\n"
             f"Bonus{total_bonus:13d}pts\n")
-            
     return TextPage(
             text,
             font = 'lcd',
diff --git a/src/sliceitoff/screens/welcome.py b/src/sliceitoff/screens/welcome.py
index f3fd25e..7078f1f 100644
--- a/src/sliceitoff/screens/welcome.py
+++ b/src/sliceitoff/screens/welcome.py
@@ -1,6 +1,8 @@
+""" screens.welcome - name, objective and scoring """
 from text import TextPage
 
 def welcome_screen():
+    """ welcome_screen - could be also considered as instruction screen """
     return TextPage(
             "           Slice it off!\n"
             " \n"
-- 
cgit v1.2.3