IntenseFinance/neovim
3
0
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2025-02-25 18:55:25 -06:00
Code Issues Packages Projects Releases Wiki Activity

docs(builtin): fix mapset() signature (#27008)

Browse Source
This commit is contained in:
zeertzjq 2024-01-14 08:44:16 +08:00 committed by GitHub
parent 0c850add3e
commit 2bdd8fad4c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 19 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
runtime/doc/builtin.txt generated
View File

@ -4273,7 +4273,8 @@ mapnew({expr1}, {expr2}) *mapnew()*
unchanged. Items can still be changed by {expr2}, if you unchanged. Items can still be changed by {expr2}, if you
don't want that use |deepcopy()| first. don't want that use |deepcopy()| first.
mapset({mode}, {abbr}, {dict}) *mapset()* mapset({mode}, {abbr}, {dict})
mapset({dict}) *mapset()*
Restore a mapping from a dictionary, possibly returned by Restore a mapping from a dictionary, possibly returned by
|maparg()| or |maplist()|. A buffer mapping, when dict.buffer |maparg()| or |maplist()|. A buffer mapping, when dict.buffer
is true, is set on the current buffer; it is up to the caller is true, is set on the current buffer; it is up to the caller

12
runtime/lua/vim/_meta/vimfn.lua generated
View File

@ -5152,6 +5152,12 @@ function vim.fn.maplist() end
--- @return any --- @return any
function vim.fn.mapnew(expr1, expr2) end function vim.fn.mapnew(expr1, expr2) end
--- @param mode string
--- @param abbr? any
--- @param dict? any
--- @return any
function vim.fn.mapset(mode, abbr, dict) end
--- Restore a mapping from a dictionary, possibly returned by --- Restore a mapping from a dictionary, possibly returned by
--- |maparg()| or |maplist()|. A buffer mapping, when dict.buffer --- |maparg()| or |maplist()|. A buffer mapping, when dict.buffer
--- is true, is set on the current buffer; it is up to the caller --- is true, is set on the current buffer; it is up to the caller
@ -5187,11 +5193,9 @@ function vim.fn.mapnew(expr1, expr2) end
--- call mapset(d) --- call mapset(d)
--- endfor --- endfor
--- ---
--- @param mode string --- @param dict any
--- @param abbr? any
--- @param dict? any
--- @return any --- @return any
function vim.fn.mapset(mode, abbr, dict) end function vim.fn.mapset(dict) end
--- When {expr} is a |List| then this returns the index of the --- When {expr} is a |List| then this returns the index of the
--- first item where {pat} matches. Each item is used as a --- first item where {pat} matches. Each item is used as a

11
src/nvim/eval.lua
View File

@ -6315,6 +6315,13 @@ M.funcs = {
signature = 'mapnew({expr1}, {expr2})', signature = 'mapnew({expr1}, {expr2})',
}, },
mapset = { mapset = {
args = { 1, 3 },
base = 1,
name = 'mapset',
params = { { 'mode', 'string' }, { 'abbr', 'any' }, { 'dict', 'any' } },
signature = 'mapset({mode}, {abbr}, {dict})',
},
mapset__1 = {
args = { 1, 3 }, args = { 1, 3 },
base = 1, base = 1,
desc = [=[ desc = [=[
@ -6354,8 +6361,8 @@ M.funcs = {
endfor endfor
]=], ]=],
name = 'mapset', name = 'mapset',
params = { { 'mode', 'string' }, { 'abbr', 'any' }, { 'dict', 'any' } }, params = { { 'dict', 'any' } },
signature = 'mapset({mode}, {abbr}, {dict})', signature = 'mapset({dict})',
}, },
match = { match = {
args = { 2, 4 }, args = { 2, 4 },