From 3adbab720a92c3cf00ea3371d04ade5d8e4b161e Mon Sep 17 00:00:00 2001
From: Tom Herman <tomherman4@gmail.com>
Date: Mon, 2 Oct 2023 23:19:12 +0300
Subject: [PATCH] add short documentation to the test_parallel scripts

---
 test_parallel     | 3 +++
 test_parallel.bat | 4 ++++
 2 files changed, 7 insertions(+)

diff --git a/test_parallel b/test_parallel
index 0a779b5..91ecf78 100644
--- a/test_parallel
+++ b/test_parallel
@@ -1,4 +1,7 @@
 #!/bin/bash
+# This script executes the flipjump tests in parallel; first compiles the program, and then runs them.
+# - Each phase is parallelized with the optimal number of threads.
+# - Each phase is called with the given command-line arguments/flags.
 
 pytest --compile -n auto "$@"
 pytest --run -n auto "$@"
diff --git a/test_parallel.bat b/test_parallel.bat
index 1233aed..2d18aba 100644
--- a/test_parallel.bat
+++ b/test_parallel.bat
@@ -1,2 +1,6 @@
+:: This script executes the flipjump tests in parallel; first compiles the program, and then runs them.
+:: - Each phase is parallelized with the optimal number of threads.
+:: - Each phase is called with the given command-line arguments/flags.
+
 pytest --compile -n auto %*
 pytest --run -n auto %*