From d987e6000661e027bec5845cf8afb61b9b4d40fc Mon Sep 17 00:00:00 2001
From: eichhornchen <eichhornchen@aspiredeb>
Date: Fri, 27 Nov 2020 18:00:54 +0100
Subject: [PATCH] Added some documentation for menudisplay

---
 squirrelbattle/display/menudisplay.py | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/squirrelbattle/display/menudisplay.py b/squirrelbattle/display/menudisplay.py
index f8df5ee..a9d0d2d 100644
--- a/squirrelbattle/display/menudisplay.py
+++ b/squirrelbattle/display/menudisplay.py
@@ -6,6 +6,9 @@ from ..resources import ResourceManager
 
 
 class MenuDisplay(Display):
+    """
+    A class to display the menu objects
+    """
     position: int
 
     def __init__(self, *args):
@@ -62,6 +65,9 @@ class MenuDisplay(Display):
 
 
 class SettingsMenuDisplay(MenuDisplay):
+    """
+    A class to display specifically a settingsmenu object
+    """
     @property
     def values(self) -> List[str]:
         return [a[1][1] + (" : "
@@ -71,6 +77,9 @@ class SettingsMenuDisplay(MenuDisplay):
 
 
 class MainMenuDisplay(Display):
+    """
+    A class to display specifically a mainmenu object
+    """
     def __init__(self, menu: MainMenu, *args):
         super().__init__(*args)
         self.menu = menu
@@ -96,6 +105,9 @@ class MainMenuDisplay(Display):
                               self.height - menuy), menuwidth)
 
 class VariableMenuDisplay(MenuDisplay):
+    """
+    A class to display a menu in which each value is associated to a parameter
+    """
     @property
     def values(self) -> List[str]:
         return [a[1][1] + (" : "