Add comments to main enum classes.

jakob-bagterp · Feb 1, 2022 · b3ce421 · b3ce421
1 parent 27b7e81
commit b3ce421
Show file tree

Hide file tree

Showing 5 changed files with 10 additions and 0 deletions.
diff --git a/src/colorist/model/background_bright_color.py b/src/colorist/model/background_bright_color.py
@@ -4,6 +4,8 @@
 
 @unique
 class BgBrightColor(Enum):
+    """Options for bright background colors."""
+
     GREEN   = "\033[102m"
     YELLOW  = "\033[103m"
     RED     = "\033[101m"

diff --git a/src/colorist/model/background_color.py b/src/colorist/model/background_color.py
@@ -3,6 +3,8 @@
 
 @unique
 class BgColor(Enum):
+    """Options for standard background colors."""
+
     GREEN   = "\033[42m"
     YELLOW  = "\033[43m"
     RED     = "\033[41m"

diff --git a/src/colorist/model/bright_color.py b/src/colorist/model/bright_color.py
@@ -3,6 +3,8 @@
 
 @unique
 class BrightColor(Enum):
+    """Options for bright colors."""
+
     GREEN   = "\033[92m"
     YELLOW  = "\033[93m"
     RED     = "\033[91m"

diff --git a/src/colorist/model/color.py b/src/colorist/model/color.py
@@ -2,6 +2,8 @@
 
 @unique
 class Color(Enum):
+    """Options for standard colors."""
+
     GREEN   = "\033[32m"
     YELLOW  = "\033[33m"
     RED     = "\033[31m"

diff --git a/src/colorist/model/effect.py b/src/colorist/model/effect.py
@@ -3,6 +3,8 @@
 
 @unique
 class Effect(Enum):
+    """Options for effects and formatting."""
+
     BOLD      = "\033[1m"
     DIM       = "\033[2m"
     UNDERLINE = "\033[4m"