From f3d8e9967d3764327c8b9564198245b3ac316c65 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?LAURENS=20J=C3=A9r=C3=B4me?= <jerome.laurens@u-bourgogne.fr>
Date: Tue, 11 Jun 2024 19:29:35 +0200
Subject: [PATCH] Document `utils.execute` in utils.lua (#479)

---
 lua/pl/utils.lua | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/lua/pl/utils.lua b/lua/pl/utils.lua
index 7c641035..ca2a0220 100644
--- 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