Merge branch 'main' into saves

1 files changed, 13 insertions, 6 deletions

diff --git a/src/color_engine.py b/src/color_engine.py
index bcb3ba2..504e84b 100644
--- a/src/color_engine.py
+++ b/src/color_engine.py
@@ -13,8 +13,6 @@ def grabColors(img_path: str, num_colors: int) -> list:
     # scale image down by factor of 10 to decrease computation time
     dim = (int(len(img[0])/10), int(len(img)/10))
     img = cv.resize(img, dim, interpolation= cv.INTER_AREA)
-    # TODO: implement KMeans clustering from scratch to
-    # improve program modularity
     clt = KMeans(n_clusters=num_colors, n_init='auto')
     clt.fit(img.reshape(-1, 3))
     return clt.cluster_centers_
@@ -52,8 +50,17 @@ def checkContrast(hex_color_list: list, hex_compliment_list: list) -> list:
     return contrast_values
 
 
-def relativeLuminance(color: list):
-    
+
+def relativeLuminance(color: list) -> float:
+    """
+    Determines the luminance of color. The luminance allows us to
+    compute the contrast between two colors by comparing their
+    relative luminance.
+
+    The magic constants in this function are all taken from the following
+    description of relative luminance:
+    https://www.w3.org/TR/WCAG20/#relativeluminancedef
+    """ 
     threshold = 0.03928 
     channels = []
 
@@ -88,13 +95,13 @@ def hexToRGB(hex_value: str) -> tuple:
     Takes in a list of Hex values and returns a tuple of those colors as rgb values
     """
     hex_value = hex_value.lstrip('#')
-    return tuple(int(hex_value[i:i+2], 16) for i in (0, 2, 4)) # Magic :DDDDDD
+    return tuple(int(hex_value[i:i+2], 16) for i in (0, 2, 4)) 
 
 
 def hexToRGB_list(hex_list: list) -> list:
     colors = []
     for color in hex_list:
         hex_value = color.lstrip('#')
-        colors.append(tuple(int(hex_value[i:i+2], 16) for i in (0, 2, 4))) # Magic :DDDDDD
+        colors.append(tuple(int(hex_value[i:i+2], 16) for i in (0, 2, 4))) 
     return colors