core: add comments

fredrikaverpil · Oct 13, 2024 · 929eac4 · 929eac4
1 parent ba8a4ef
commit 929eac4
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/lua/neotest-golang/options.lua b/lua/neotest-golang/options.lua
@@ -26,6 +26,7 @@ local runner_defaults = {
       build_spec = function(args)
         return M.build_gotest_spec(args)
       end,
+      ---@param cmd_data TestCommandData
       cmd = function(cmd_data)
         local cmd = { "go", "test", "-json" }
         local go_test_args = defaults.go_test_args
@@ -61,8 +62,10 @@ local runner_defaults = {
     },
     gotestsum = {
       build_spec = function(args)
+        -- gotestsum uses the same logic to build the runspec as the 'go' runner
         return M.build_gotest_spec(args)
       end,
+      ---@param cmd_data TestCommandData
       cmd = function(cmd_data)
         local async = require("neotest.async")
         local json_filepath = vim.fs.normalize(async.fn.tempname())
@@ -101,6 +104,7 @@ local runner_defaults = {
         return cmd, json_filepath
       end,
       results = function(spec, result, tree)
+        -- gotestsum uses the same logic to process the results as the 'go' runner
         return M.process_gotest_results(spec, result, tree)
       end,
     },