Docs: Comments

lib/wheel.py

@@ -1,8 +1,10 @@
+# Utilities for constructing the whisky flavor wheel SVG.
 from typing import List, Tuple
 import math
 
 ###################################################################################
 
+# Base SVG template with placeholder for the dynamic graph coordinates.
 SVG_BASE = """
 <svg id="wheel"
      viewBox="0 0 500 500"
@@ -89,17 +91,17 @@ def compute_wheel_points(
     center: float = 250.0,
     input_ratio: float = 40.0,
 ) -> List[Tuple[float, float]]:
-    """
-    Repliziert die JS-Logik:
-      angle = (360/segments*i + offsetAngle - 90) * (π*2/360)
-      r = vals[i] * inputRatio + innerRadius
-      x = cos(angle) * r + center
-      y = sin(angle) * r + center
-    """
+    # Repliziert die JS-Logik:
+    #   angle = (360/segments*i + offsetAngle - 90) * (π*2/360)
+    #   r = vals[i] * inputRatio + innerRadius
+    #   x = cos(angle) * r + center
+    #   y = sin(angle) * r + center
     pts = []
     for i, v in enumerate(vals):
+        # Align each segment by converting the polar angle to radians and shifting upwards.
         angle_deg = (360.0 / segments) * i + offset_angle_deg - 90.0
         angle = angle_deg * (math.pi * 2.0 / 360.0)
+        # Map the normalized input value onto the wheel radius and translate back to SVG center.
         r = v * input_ratio + inner_radius
         x = math.cos(angle) * r + center
         y = math.sin(angle) * r + center
@@ -117,6 +119,7 @@ def build_svg_with_values(
     center: float = 250.0,
     input_ratio: float = 40.0,
 ) -> str:
+    # Populate the SVG template with cartesian points generated from the input values.
     pts = compute_wheel_points(
         vals,
         segments=segments,
@@ -125,7 +128,8 @@ def build_svg_with_values(
         center=center,
         input_ratio=input_ratio,
     )
+    # Build the `points` attribute string in the format expected by the SVG polyline element.
     points_attr = " ".join(f"{x:.2f},{y:.2f}" for x, y in pts)
     
     return SVG_BASE.format(POINTS=points_attr)
-        
+        

whisky-wheel.code-workspace

@@ -0,0 +1,8 @@
+{
+	"folders": [
+		{
+			"path": "."
+		}
+	],
+	"settings": {}
+}