[doc] Add documentation about runner

Author: elgopher

Diff for: gui/gui.lua

@@ -143,6 +143,7 @@ local function start_test(item)
 	run_tests_in_seperate_process()
 end
 
+-- test_started event is published by the runner process for each started test
 on_event("test_started", function(e)
 	if e._from != runner_pid then
 		-- discard events from old runners
@@ -159,6 +160,7 @@ on_event("test_started", function(e)
 	sfx(1)
 end)
 
+-- test_finished event is published by the runner process for each started test
 on_event("test_finished", function(e)
 	if e._from != runner_pid then
 		-- discard events from old runners
@@ -236,6 +238,8 @@ on_event("test_finished", function(e)
 	-- update text for all parents
 end)
 
+-- print event is published by the runner process for each print command
+-- executed by test
 on_event("print", function(e)
 	if e._from != runner_pid then
 		-- discard events from old runners
@@ -245,6 +249,7 @@ on_event("print", function(e)
 	printed_lines:print(e.test.id, e.text)
 end)
 
+-- done event is published by the runner process when all test have finished
 on_event("done", function(e)
 	if e._from != runner_pid then
 		-- discard events from old runners

Diff for: runner.lua

@@ -1,8 +1,12 @@
 -- (c) 2024 Jacek Olszak
 -- This code is licensed under MIT license (see LICENSE for details)
 
--- runner is a seperate application spawn by gui in a dedicated process.
--- Therefore tests which are run does not block game loop.
+-- runner is a seperate application spawn by gui/cli in a dedicated process.
+-- runner runs user tests. Once done, runner exits.
+-- runner is needed because running tests from inside GUI will block the game
+-- loop or will have a potential side effects (like drawing in the window)
+
+-- runner send messages with events to communicate with the parent process.
 
 include "api.lua"