Improve e2tool check_results() doc

Signed-off-by: Tobias Ulmer <tu@emlix.com>

diff --git a/local/e2tool.lua b/local/e2tool.lua
index 5a8105d59576a1dc5452e38e6cde0b88f1df6b00..2b5eeed87aab715990458606a1d9b65e7a70e5f6 100644 (file)
--- a/local/e2tool.lua
+++ b/local/e2tool.lua
@@ -231,12 +231,15 @@ local function load_user_config2(info, path, types)
 end
 
 --- check results.
+-- @param info Info table.
+-- @return True on success, false on error.
+-- @return Error object on failure.
 local function check_results(info)
     local e, rc, re
 
-    for _,f in ipairs(e2tool_ftab.check_result) do
+    for _,check_result_cb in ipairs(e2tool_ftab.check_result) do
         for r,_ in pairs(info.results) do
-            rc, re = f(info, r)
+            rc, re = check_result_cb(info, r)
             if not rc then
                 e = err.new("Error while checking results")
                 return false, e:cat(re)