add short documentation to the test_parallel scripts

tomhea · Oct 2, 2023 · 3adbab7 · 3adbab7
1 parent d687816
commit 3adbab7
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git 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
@@ -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 %*