diff options
Diffstat (limited to 'runtime/doc')
| -rw-r--r-- | runtime/doc/help.txt | 1 | ||||
| -rw-r--r-- | runtime/doc/lua.txt | 17 | ||||
| -rw-r--r-- | runtime/doc/quickref.txt | 1 |
3 files changed, 9 insertions, 10 deletions
diff --git a/runtime/doc/help.txt b/runtime/doc/help.txt index 651dce08bf..b8526b55e9 100644 --- a/runtime/doc/help.txt +++ b/runtime/doc/help.txt @@ -171,7 +171,6 @@ DEVELOPING NVIM Standard plugins ~ *standard-plugin-list* -|matchit.txt| Extended |%| matching |pi_gzip.txt| Reading and writing compressed files |pi_health.txt| Healthcheck framework |pi_msgpack.txt| msgpack utilities diff --git a/runtime/doc/lua.txt b/runtime/doc/lua.txt index aea19d7bf0..ada07a71f8 100644 --- a/runtime/doc/lua.txt +++ b/runtime/doc/lua.txt @@ -1512,7 +1512,7 @@ vim.wo *vim.wo* Lua module: vim *lua-vim* vim.cmd *vim.cmd()* - Execute Vim script commands. + Executes Vim script commands. Note that `vim.cmd` can be indexed with a command name to return a callable function to the command. @@ -1596,7 +1596,7 @@ vim.inspect *vim.inspect()* • https://github.com/mpeterv/vinspect vim.keycode({str}) *vim.keycode()* - Translate keycodes. + Translates keycodes. Example: >lua local k = vim.keycode @@ -1619,7 +1619,7 @@ vim.lua_omnifunc({find_start}, {_}) *vim.lua_omnifunc()* Activate using `set omnifunc=v:lua.vim.lua_omnifunc` in a Lua buffer. vim.notify({msg}, {level}, {opts}) *vim.notify()* - Display a notification to the user. + Displays a notification to the user. This function can be overridden by plugins to display notifications using a custom provider (such as the system notification provider). By default, @@ -1631,7 +1631,7 @@ vim.notify({msg}, {level}, {opts}) *vim.notify()* • {opts} (table|nil) Optional parameters. Unused by default. vim.notify_once({msg}, {level}, {opts}) *vim.notify_once()* - Display a notification only one time. + Displays a notification only one time. Like |vim.notify()|, but subsequent calls with the same message will not display a notification. @@ -1760,7 +1760,7 @@ vim.schedule_wrap({fn}) *vim.schedule_wrap()* • |vim.in_fast_event()| vim.system({cmd}, {opts}, {on_exit}) *vim.system()* - Run a system command + Runs a system command or throws an error if {cmd} cannot be run. Examples: >lua local on_exit = function(obj) @@ -1770,15 +1770,16 @@ vim.system({cmd}, {opts}, {on_exit}) *vim.system()* print(obj.stderr) end - -- Run asynchronously + -- Runs asynchronously: vim.system({'echo', 'hello'}, { text = true }, on_exit) - -- Run synchronously + -- Runs synchronously: local obj = vim.system({'echo', 'hello'}, { text = true }):wait() -- { code = 0, signal = 0, stdout = 'hello', stderr = '' } < - See |uv.spawn()| for more details. + See |uv.spawn()| for more details. Note: unlike |uv.spawn()|, vim.system + throws an error if {cmd} cannot be run. Parameters: ~ • {cmd} (string[]) Command to execute diff --git a/runtime/doc/quickref.txt b/runtime/doc/quickref.txt index fd9eab8646..f976eb7464 100644 --- a/runtime/doc/quickref.txt +++ b/runtime/doc/quickref.txt @@ -817,7 +817,6 @@ Short explanation of each option: *option-list* 'path' 'pa' list of directories searched with "gf" et.al. 'preserveindent' 'pi' preserve the indent structure when reindenting 'previewheight' 'pvh' height of the preview window -'previewpopup' 'pvp' use popup window for preview 'previewwindow' 'pvw' identifies the preview window 'pumheight' 'ph' maximum number of items to show in the popup menu 'pumwidth' 'pw' minimum width of the popup menu |