neovim

commit 2bdd8fad4cf4008125ce540453434888c07044a6
parent 0c850add3ecedec5b7dea62f0dd152f3421b66fc
Author: zeertzjq <zeertzjq@outlook.com>
Date:   Sun, 14 Jan 2024 08:44:16 +0800

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


Diffstat:
M
runtime/doc/builtin.txt
 | 
3
++-
M
runtime/lua/vim/_meta/vimfn.lua
 | 
12
++++++++----
M
src/nvim/eval.lua
 | 
11
+++++++++--

3 files changed, 19 insertions(+), 7 deletions(-)
diff --git a/runtime/doc/builtin.txt b/runtime/doc/builtin.txt
@@ -4273,7 +4273,8 @@ mapnew({expr1}, {expr2})                                              *mapnew()*
 		unchanged.  Items can still be changed by {expr2}, if you
 		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
 		|maparg()| or |maplist()|.  A buffer mapping, when dict.buffer
 		is true, is set on the current buffer; it is up to the caller
diff --git a/runtime/lua/vim/_meta/vimfn.lua b/runtime/lua/vim/_meta/vimfn.lua
@@ -5152,6 +5152,12 @@ function vim.fn.maplist() end
 --- @return any
 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
 --- |maparg()| or |maplist()|.  A buffer mapping, when dict.buffer
 --- 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)
 ---   endfor
 ---
---- @param mode string
---- @param abbr? any
---- @param dict? any
+--- @param dict 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
 --- first item where {pat} matches.  Each item is used as a
diff --git a/src/nvim/eval.lua b/src/nvim/eval.lua
@@ -6317,6 +6317,13 @@ M.funcs = {
   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 },
+    base = 1,
     desc = [=[
       Restore a mapping from a dictionary, possibly returned by
       |maparg()| or |maplist()|.  A buffer mapping, when dict.buffer
@@ -6354,8 +6361,8 @@ M.funcs = {
       	endfor
     ]=],
     name = 'mapset',
-    params = { { 'mode', 'string' }, { 'abbr', 'any' }, { 'dict', 'any' } },
-    signature = 'mapset({mode}, {abbr}, {dict})',
+    params = { { 'dict', 'any' } },
+    signature = 'mapset({dict})',
   },
   match = {
     args = { 2, 4 },