add/expand comments about each code file

FoamyGuy · FoamyGuy · commit 0f3f74a9751f · 2025-12-18T10:28:23.000-06:00
diff --git a/Fruit_Jam/Fruit_Jam_Card_Maker/project_code/card.template.html b/Fruit_Jam/Fruit_Jam_Card_Maker/project_code/card.template.html
@@ -1,5 +1,6 @@
 <!-- SPDX-FileCopyrightText: 2025 Tim Cocks for Adafruit Industries -->
 <!-- SPDX-License-Identifier: MIT -->
+<!-- quarter fold greeting card template file for Fruit Jam greeting card maker -->
 <!DOCTYPE html>
 <html lang="en">
 <head>
diff --git a/Fruit_Jam/Fruit_Jam_Card_Maker/project_code/card_maker_helpers.py b/Fruit_Jam/Fruit_Jam_Card_Maker/project_code/card_maker_helpers.py
@@ -1,5 +1,8 @@
 # SPDX-FileCopyrightText: 2025 Tim Cocks for Adafruit Industries
 # SPDX-License-Identifier: MIT
+"""
+Helper functions and class for the Fruit Jam greeting card maker.
+"""
 import math
 import random
 
diff --git a/Fruit_Jam/Fruit_Jam_Card_Maker/project_code/code.py b/Fruit_Jam/Fruit_Jam_Card_Maker/project_code/code.py
@@ -1,7 +1,9 @@
 # SPDX-FileCopyrightText: 2025 Tim Cocks for Adafruit Industries
 # SPDX-License-Identifier: MIT
 """
-Greeting card maker for Fruit Jam
+Greeting card maker for Fruit Jam. Input messages for the front
+and inside of the card and select a custom image for the front,
+or use a snowflake image designed right inside the app.
 """
 import json
 import os
@@ -22,8 +24,14 @@
 from adafruit_checkbox import CheckBox
 from adafruit_button import Button
 
-from card_maker_helpers import (PointHighlighterCache, svg_points, fill_polygon,
-                                draw_snowflake, random_polygon, distance)
+from card_maker_helpers import (
+    PointHighlighterCache,
+    svg_points,
+    fill_polygon,
+    draw_snowflake,
+    random_polygon,
+    distance,
+)
 
 # change emoji here if you want to use different ones
 emoji = "🎄⛄❄️🌟"
diff --git a/Fruit_Jam/Fruit_Jam_Card_Maker/project_code/snowflake.template.svg b/Fruit_Jam/Fruit_Jam_Card_Maker/project_code/snowflake.template.svg
@@ -1,5 +1,6 @@
 <!-- SPDX-FileCopyrightText: 2025 Tim Cocks for Adafruit Industries -->
 <!-- SPDX-License-Identifier: MIT -->
+<!-- snowflake SVG template file with mirror flipped quadrants for Fruit Jam greeting card maker -->
 <svg viewBox="0 0 240 240" xmlns="http://www.w3.org/2000/svg">
     {% for polygon_points in context["polygons"] %}
         <polygon points="{% autoescape off %}{{ polygon_points }}{% autoescape on %}" fill="#{{ context['color'] }}"/>
