Clarify test_env.need_rock description wrt return value

2 files changed, 4 insertions, 2 deletions

diff --git a/spec/upload_spec.lua b/spec/upload_spec.lua
index 8b3e0433..6ec8e302 100644
--- a/spec/upload_spec.lua
+++ b/spec/upload_spec.lua
@@ -50,7 +50,7 @@ describe("LuaRocks upload tests #blackbox #b_upload", function()
 
    describe("LuaRocks upload tests with Xavante server #mock", function()
       before_each(function()
-         assert.is.truthy(test_env.need_rock("restserver-xavante"))
+         assert.is_true(test_env.need_rock("restserver-xavante"))
          local final_command = test_env.execute_helper(testing_paths.lua .. " " .. testing_paths.testing_dir .. "/mock-server.lua &", true, test_env.env_variables)
          os.execute(final_command)
       end)
diff --git a/test/test_environment.lua b/test/test_environment.lua
index c781af4b..bc1e5277 100644
--- a/test/test_environment.lua
+++ b/test/test_environment.lua
@@ -533,7 +533,9 @@ function test_env.setup_specs(extra_rocks)
    end
 end
 
---- Test if required rock is installed if not, install it
+--- Test if required rock is installed and if not, install it.
+-- Return `true` if the rock is already installed or has been installed successfully,
+-- `false` if installation failed.
 function test_env.need_rock(rock)
    print("Check if " .. rock .. " is installed")
    if test_env.run.luarocks_noprint_nocov(test_env.quiet("show " .. rock)) then