diff options
author | Lewis Russell <lewis6991@gmail.com> | 2024-01-09 17:36:46 +0000 |
---|---|---|
committer | Lewis Russell <me@lewisr.dev> | 2024-01-11 16:24:12 +0000 |
commit | 2f9ee9b6cfc61a0504fc0bc22bdf481828e2ea91 (patch) | |
tree | 06884cc40b3f6e7c0dd47f4018c8ba0f671ba610 /runtime/lua/vim/_editor.lua | |
parent | a767c046f4e6bff1412269d56a8edfe33857d954 (diff) | |
download | rneovim-2f9ee9b6cfc61a0504fc0bc22bdf481828e2ea91.tar.gz rneovim-2f9ee9b6cfc61a0504fc0bc22bdf481828e2ea91.tar.bz2 rneovim-2f9ee9b6cfc61a0504fc0bc22bdf481828e2ea91.zip |
fix(doc): improve doc generation of types using lpeg
Added a lpeg grammar for LuaCATS and use it in lua2dox.lua
Diffstat (limited to 'runtime/lua/vim/_editor.lua')
-rw-r--r-- | runtime/lua/vim/_editor.lua | 7 |
1 files changed, 3 insertions, 4 deletions
diff --git a/runtime/lua/vim/_editor.lua b/runtime/lua/vim/_editor.lua index cde61697b6..4fe601dfd5 100644 --- a/runtime/lua/vim/_editor.lua +++ b/runtime/lua/vim/_editor.lua @@ -95,7 +95,7 @@ vim.log = { --- throws an error if {cmd} cannot be run. --- --- @param cmd (string[]) Command to execute ---- @param opts (SystemOpts|nil) Options: +--- @param opts vim.SystemOpts? Options: --- - cwd: (string) Set the current working directory for the sub-process. --- - env: table<string,string> Set environment variables for the new process. Inherits the --- current environment with `NVIM` set to |v:servername|. @@ -118,7 +118,7 @@ vim.log = { --- parent exits. Note that the child process will still keep the parent's event loop alive --- unless the parent process calls |uv.unref()| on the child's process handle. --- ---- @param on_exit (function|nil) Called when subprocess exits. When provided, the command runs +--- @param on_exit? fun(out: vim.SystemCompleted) Called when subprocess exits. When provided, the command runs --- asynchronously. Receives SystemCompleted object, see return of SystemObj:wait(). --- --- @return vim.SystemObj Object with the fields: @@ -219,10 +219,9 @@ do --- ``` --- ---@see |paste| - ---@alias paste_phase -1 | 1 | 2 | 3 --- ---@param lines string[] # |readfile()|-style list of lines to paste. |channel-lines| - ---@param phase paste_phase -1: "non-streaming" paste: the call contains all lines. + ---@param phase (-1|1|2|3) -1: "non-streaming" paste: the call contains all lines. --- If paste is "streamed", `phase` indicates the stream state: --- - 1: starts the paste (exactly once) --- - 2: continues the paste (zero or more times) |