From e2d48674b108e02c4e0f59306dae5afd70b6186d Mon Sep 17 00:00:00 2001 From: Olivier Gayot Date: Mon, 15 Nov 2021 23:32:51 +0100 Subject: Document the color module Signed-off-by: Olivier Gayot --- cameltris/color.py | 6 ++++++ 1 file changed, 6 insertions(+) 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) -- cgit v1.2.3