docs: small fixes (#25831)

Co-authored-by: Peter Aronoff <peter@aronoff.org>
This commit is contained in:
dundargoc 2023-11-03 00:22:02 +01:00 committed by GitHub
parent c1a05f6112
commit 5a2543c159
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 21 additions and 29 deletions

View File

@ -171,7 +171,6 @@ DEVELOPING NVIM
Standard plugins ~ Standard plugins ~
*standard-plugin-list* *standard-plugin-list*
|matchit.txt| Extended |%| matching
|pi_gzip.txt| Reading and writing compressed files |pi_gzip.txt| Reading and writing compressed files
|pi_health.txt| Healthcheck framework |pi_health.txt| Healthcheck framework
|pi_msgpack.txt| msgpack utilities |pi_msgpack.txt| msgpack utilities

View File

@ -1512,7 +1512,7 @@ vim.wo *vim.wo*
Lua module: vim *lua-vim* Lua module: vim *lua-vim*
vim.cmd *vim.cmd()* 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 Note that `vim.cmd` can be indexed with a command name to return a
callable function to the command. callable function to the command.
@ -1596,7 +1596,7 @@ vim.inspect *vim.inspect()*
• https://github.com/mpeterv/vinspect • https://github.com/mpeterv/vinspect
vim.keycode({str}) *vim.keycode()* vim.keycode({str}) *vim.keycode()*
Translate keycodes. Translates keycodes.
Example: >lua Example: >lua
local k = vim.keycode 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. Activate using `set omnifunc=v:lua.vim.lua_omnifunc` in a Lua buffer.
vim.notify({msg}, {level}, {opts}) *vim.notify()* 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 This function can be overridden by plugins to display notifications using
a custom provider (such as the system notification provider). By default, 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. • {opts} (table|nil) Optional parameters. Unused by default.
vim.notify_once({msg}, {level}, {opts}) *vim.notify_once()* 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 Like |vim.notify()|, but subsequent calls with the same message will not
display a notification. display a notification.
@ -1760,7 +1760,7 @@ vim.schedule_wrap({fn}) *vim.schedule_wrap()*
• |vim.in_fast_event()| • |vim.in_fast_event()|
vim.system({cmd}, {opts}, {on_exit}) *vim.system()* 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 Examples: >lua
local on_exit = function(obj) local on_exit = function(obj)
@ -1770,15 +1770,16 @@ vim.system({cmd}, {opts}, {on_exit}) *vim.system()*
print(obj.stderr) print(obj.stderr)
end end
-- Run asynchronously -- Runs asynchronously:
vim.system({'echo', 'hello'}, { text = true }, on_exit) vim.system({'echo', 'hello'}, { text = true }, on_exit)
-- Run synchronously -- Runs synchronously:
local obj = vim.system({'echo', 'hello'}, { text = true }):wait() local obj = vim.system({'echo', 'hello'}, { text = true }):wait()
-- { code = 0, signal = 0, stdout = 'hello', stderr = '' } -- { 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: ~ Parameters: ~
• {cmd} (string[]) Command to execute • {cmd} (string[]) Command to execute

View File

@ -817,7 +817,6 @@ Short explanation of each option: *option-list*
'path' 'pa' list of directories searched with "gf" et.al. 'path' 'pa' list of directories searched with "gf" et.al.
'preserveindent' 'pi' preserve the indent structure when reindenting 'preserveindent' 'pi' preserve the indent structure when reindenting
'previewheight' 'pvh' height of the preview window 'previewheight' 'pvh' height of the preview window
'previewpopup' 'pvp' use popup window for preview
'previewwindow' 'pvw' identifies the preview window 'previewwindow' 'pvw' identifies the preview window
'pumheight' 'ph' maximum number of items to show in the popup menu 'pumheight' 'ph' maximum number of items to show in the popup menu
'pumwidth' 'pw' minimum width of the popup menu 'pumwidth' 'pw' minimum width of the popup menu

View File

@ -69,7 +69,7 @@ vim.log = {
} }
-- TODO(lewis6991): document that the signature is system({cmd}, [{opts},] {on_exit}) -- TODO(lewis6991): document that the signature is system({cmd}, [{opts},] {on_exit})
--- Run a system command --- Runs a system command or throws an error if {cmd} cannot be run.
--- ---
--- Examples: --- Examples:
--- ---
@ -82,16 +82,17 @@ vim.log = {
--- print(obj.stderr) --- print(obj.stderr)
--- end --- end
--- ---
--- -- Run asynchronously --- -- Runs asynchronously:
--- vim.system({'echo', 'hello'}, { text = true }, on_exit) --- vim.system({'echo', 'hello'}, { text = true }, on_exit)
--- ---
--- -- Run synchronously --- -- Runs synchronously:
--- local obj = vim.system({'echo', 'hello'}, { text = true }):wait() --- local obj = vim.system({'echo', 'hello'}, { text = true }):wait()
--- -- { code = 0, signal = 0, stdout = 'hello', stderr = '' } --- -- { 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.
--- ---
--- @param cmd (string[]) Command to execute --- @param cmd (string[]) Command to execute
--- @param opts (SystemOpts|nil) Options: --- @param opts (SystemOpts|nil) Options:
@ -370,7 +371,7 @@ end
local VIM_CMD_ARG_MAX = 20 local VIM_CMD_ARG_MAX = 20
--- 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 --- Note that `vim.cmd` can be indexed with a command name to return a callable function to the
--- command. --- command.
@ -587,7 +588,7 @@ function vim.defer_fn(fn, timeout)
return timer return timer
end end
--- Display a notification to the user. --- Displays a notification to the user.
--- ---
--- This function can be overridden by plugins to display notifications using a --- This function can be overridden by plugins to display notifications using a
--- custom provider (such as the system notification provider). By default, --- custom provider (such as the system notification provider). By default,
@ -609,7 +610,7 @@ end
do do
local notified = {} local notified = {}
--- Display a notification only one time. --- Displays a notification only one time.
--- ---
--- Like |vim.notify()|, but subsequent calls with the same message will not --- Like |vim.notify()|, but subsequent calls with the same message will not
--- display a notification. --- display a notification.
@ -690,7 +691,7 @@ function vim._on_key(char)
end end
end end
--- Generate a list of possible completions for the string. --- Generates a list of possible completions for the string.
--- String has the pattern. --- String has the pattern.
--- ---
--- 1. Can we get it to just return things in the global namespace with that name prefix --- 1. Can we get it to just return things in the global namespace with that name prefix
@ -917,7 +918,7 @@ function vim.print(...)
return ... return ...
end end
--- Translate keycodes. --- Translates keycodes.
--- ---
--- Example: --- Example:
--- ---
@ -1030,7 +1031,7 @@ function vim.deprecate(name, alternative, version, plugin, backtrace)
return displayed and msg or nil return displayed and msg or nil
end end
--- Create builtin mappings (incl. menus). --- Creates builtin mappings (incl. menus).
--- Called once on startup. --- Called once on startup.
function vim._init_default_mappings() function vim._init_default_mappings()
-- mappings -- mappings

View File

@ -1,4 +1,4 @@
*matchit.txt* Extended "%" matching *matchit.txt* Extended |%| matching
For instructions on installing this file, type For instructions on installing this file, type
`:help matchit-install` `:help matchit-install`

View File

@ -60,18 +60,10 @@ local new_layout = {
-- TODO: These known invalid |links| require an update to the relevant docs. -- TODO: These known invalid |links| require an update to the relevant docs.
local exclude_invalid = { local exclude_invalid = {
["'previewpopup'"] = "quickref.txt",
["'pvp'"] = "quickref.txt",
["'string'"] = "eval.txt", ["'string'"] = "eval.txt",
Query = 'treesitter.txt', Query = 'treesitter.txt',
['eq?'] = 'treesitter.txt',
matchit = 'vim_diff.txt', matchit = 'vim_diff.txt',
['matchit.txt'] = 'help.txt',
["set!"] = "treesitter.txt", ["set!"] = "treesitter.txt",
['v:_null_blob'] = 'builtin.txt',
['v:_null_dict'] = 'builtin.txt',
['v:_null_list'] = 'builtin.txt',
['v:_null_string'] = 'builtin.txt',
} }
-- False-positive "invalid URLs". -- False-positive "invalid URLs".