From 05e6ef2650ed9c39722cec8f7ec5e315543a1d36 Mon Sep 17 00:00:00 2001
From: William Oldham <github@binaryoverload.co.uk>
Date: Mon, 30 Dec 2024 18:05:58 +0000
Subject: [PATCH] Add explanation to format.sh

---
 format.sh | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/format.sh b/format.sh
index 321097a1..8ed2ab0d 100644
--- a/format.sh
+++ b/format.sh
@@ -1,5 +1,9 @@
 #!/bin/bash
 
+# This script processes all files in the data directory using jq to:
+# - Ensure all JSON files are formatted correctly with tabs
+# - Catch any JSON files with syntax errors and log them to error.log for fixing
+
 # Remove any existing error log
 rm -f error.log