diff options
| author | Justin M. Keyes <justinkz@gmail.com> | 2025-06-07 07:49:04 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2025-06-07 07:49:04 -0700 |
| commit | 96a0e5f265d11e7913ce71a3a1981b267bda79e5 (patch) | |
| tree | c09bff1fe3d803f0a84cbef9af40e60783dfbc0c /runtime/lua/vim/_editor.lua | |
| parent | c8c78b531bdbc1a6d555d33b74889ba8f3420fbf (diff) | |
docs: lua, UI events #34261
Diffstat (limited to 'runtime/lua/vim/_editor.lua')
| -rw-r--r-- | runtime/lua/vim/_editor.lua | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/runtime/lua/vim/_editor.lua b/runtime/lua/vim/_editor.lua index e96cc56b70..1c11960c8f 100644 --- a/runtime/lua/vim/_editor.lua +++ b/runtime/lua/vim/_editor.lua @@ -130,9 +130,10 @@ local utfs = { --- @return vim.SystemObj Object with the fields: --- - cmd (string[]) Command name and args --- - pid (integer) Process ID ---- - wait (fun(timeout: integer|nil): SystemCompleted) Wait for the process to complete. Upon ---- timeout the process is sent the KILL signal (9) and the exit code is set to 124. Cannot ---- be called in |api-fast|. +--- - wait (fun(timeout: integer|nil): SystemCompleted) Wait for the process to complete, +--- including any open handles for background processes (e.g., `bash -c 'sleep 10 &'`). +--- To avoid waiting for handles, set stdout=false and stderr=false. Upon timeout the process is +--- sent the KILL signal (9) and the exit code is set to 124. Cannot be called in |api-fast|. --- - SystemCompleted is an object with the fields: --- - code: (integer) --- - signal: (integer) |