Document utils.execute in utils.lua (#479)

lunarmodules · Jun 11, 2024 · f3d8e99 · f3d8e99
1 parent a26ca8d
commit f3d8e99
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/lua/pl/utils.lua b/lua/pl/utils.lua
@@ -24,6 +24,7 @@ local _function_factories = {}
 
 
 local utils = { _VERSION = "1.14.0" }
+
 for k, v in pairs(compat) do utils[k] = v  end
 
 --- Some standard patterns
@@ -585,6 +586,11 @@ end
 --- OS functions
 -- @section OS-functions
 
+--- Execute a shell command.
+-- This function is a copy of `compat.execute`.
+-- @class function
+-- @name utils.execute
+
 --- execute a shell command and return the output.
 -- This function redirects the output to tempfiles and returns the content of those files.
 -- @param cmd a shell command