From e80345eb462bb78eb691db9aec4e34995dc8b8c7 Mon Sep 17 00:00:00 2001 From: Olivier Gayot Date: Wed, 22 Dec 2021 14:13:27 +0100 Subject: Add documentation to the base_screen module Signed-off-by: Olivier Gayot --- cameltris/screens/base_screen.py | 7 +++++-- 1 file 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 """ -- cgit v1.2.3