summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorOlivier Gayot <olivier.gayot@sigexec.com>2021-11-15 23:32:51 +0100
committerOlivier Gayot <olivier.gayot@sigexec.com>2021-11-15 23:32:51 +0100
commite2d48674b108e02c4e0f59306dae5afd70b6186d (patch)
tree84a8f1598844a2c8aec49dbb2930c9d18c3d4e98
parente8d80b105cea52561da8db828660e552a5ff1d45 (diff)
Document the color module
Signed-off-by: Olivier Gayot <olivier.gayot@sigexec.com>
-rw-r--r--cameltris/color.py6
1 files changed, 6 insertions, 0 deletions
diff --git a/cameltris/color.py b/cameltris/color.py
index ac3e660..aec6d0d 100644
--- a/cameltris/color.py
+++ b/cameltris/color.py
@@ -1,7 +1,13 @@
+""" This modules defines color helpers """
+
from enum import Enum
class Color(Enum):
+ """ An enumeration of the different colors used in the game
+ This enumeration can be passed (using .value) to pygame functions that
+ expect a RGB tuple.
+ """
BLACK = (0, 0, 0)
WHITE = (0XFF, 0XFF, 0XFF)
BROWN = (163, 75, 31)