summaryrefslogtreecommitdiff
path: root/cameltris/screens
diff options
context:
space:
mode:
authorOlivier Gayot <olivier.gayot@sigexec.com>2021-12-22 14:13:27 +0100
committerOlivier Gayot <olivier.gayot@sigexec.com>2021-12-22 14:13:43 +0100
commite80345eb462bb78eb691db9aec4e34995dc8b8c7 (patch)
treea57e6a1e260399e4b27e4778d8962643535e552b /cameltris/screens
parent185eeb89c31da7dc245d16448469d35a2d0fad7a (diff)
Add documentation to the base_screen module
Signed-off-by: Olivier Gayot <olivier.gayot@sigexec.com>
Diffstat (limited to 'cameltris/screens')
-rw-r--r--cameltris/screens/base_screen.py7
1 files changed, 5 insertions, 2 deletions
diff --git a/cameltris/screens/base_screen.py b/cameltris/screens/base_screen.py
index 87c15f4..45f3954 100644
--- a/cameltris/screens/base_screen.py
+++ b/cameltris/screens/base_screen.py
@@ -1,11 +1,14 @@
+""" Module that defines the base abstract class for a screen """
+
import abc
class Screen(abc.ABC):
+ """ Represents an abstract class for a screen """
@abc.abstractmethod
def refresh(self) -> None:
- pass
+ """ Refresh the screen"""
@abc.abstractmethod
def oneframe(self) -> None:
- pass
+ """ Perform the updates needed for the current frame """