diff options
| author | James Trew <66286082+jamestrew@users.noreply.github.com> | 2024-10-03 10:45:51 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-10-03 03:45:51 -0700 |
| commit | 385fbfb3e739b457027b469782678f86eefdf7fc (patch) | |
| tree | 8e604da45cc3f172e60904631da5d16c64debee5 /runtime | |
| parent | c6abc97006eee7fc89baefad2e1bddb248187f2e (diff) | |
| download | rneovim-385fbfb3e739b457027b469782678f86eefdf7fc.tar.gz rneovim-385fbfb3e739b457027b469782678f86eefdf7fc.tar.bz2 rneovim-385fbfb3e739b457027b469782678f86eefdf7fc.zip | |
docs: improve luacats support #30580
Some composite/compound types even as basic as `(string|number)[]` are
not currently supported by the luacats LPEG grammar used by gen_vimdoc.
It would be parsed & rendered as just `string|number`.
Changeset adds better support for these types.
Diffstat (limited to 'runtime')
| -rw-r--r-- | runtime/doc/lsp.txt | 2 | ||||
| -rw-r--r-- | runtime/doc/lua.txt | 4 | ||||
| -rw-r--r-- | runtime/lua/vim/_meta/builtin.lua | 4 | ||||
| -rw-r--r-- | runtime/lua/vim/lsp/rpc.lua | 2 |
4 files changed, 6 insertions, 6 deletions
diff --git a/runtime/doc/lsp.txt b/runtime/doc/lsp.txt index 086a6dbbda..e06d400b63 100644 --- a/runtime/doc/lsp.txt +++ b/runtime/doc/lsp.txt @@ -2303,7 +2303,7 @@ Lua module: vim.lsp.rpc *lsp-rpc* *vim.lsp.rpc.PublicClient* Fields: ~ - • {request} (`fun(method: string, params: table?, callback: fun(err: lsp.ResponseError?, result: any), notify_reply_callback: fun(integer)?):boolean,integer?`) + • {request} (`fun(method: string, params: table?, callback: fun(err: lsp.ResponseError?, result: any), notify_reply_callback: fun(message_id: integer)?):boolean,integer?`) see |vim.lsp.rpc.request()| • {notify} (`fun(method: string, params: any):boolean`) see |vim.lsp.rpc.notify()| diff --git a/runtime/doc/lua.txt b/runtime/doc/lua.txt index e793a97fe1..6269eb0c5b 100644 --- a/runtime/doc/lua.txt +++ b/runtime/doc/lua.txt @@ -752,8 +752,8 @@ vim.diff({a}, {b}, {opts}) *vim.diff()* the internal diff library. Return: ~ - (`string|integer[]`) See {opts.result_type}. `nil` if {opts.on_hunk} - is given. + (`string|integer[][]?`) See {opts.result_type}. `nil` if + {opts.on_hunk} is given. ============================================================================== diff --git a/runtime/lua/vim/_meta/builtin.lua b/runtime/lua/vim/_meta/builtin.lua index 3aca3cdfa5..1a3f272290 100644 --- a/runtime/lua/vim/_meta/builtin.lua +++ b/runtime/lua/vim/_meta/builtin.lua @@ -182,8 +182,8 @@ function vim.str_utf_end(str, index) end --- that sequence. --- @param str string --- @param index? integer ---- @return integer UTF-32 index ---- @return integer UTF-16 index +--- @return integer # UTF-32 index +--- @return integer # UTF-16 index function vim.str_utfindex(str, index) end --- The result is a String, which is the text {str} converted from diff --git a/runtime/lua/vim/lsp/rpc.lua b/runtime/lua/vim/lsp/rpc.lua index bc24501eae..e79dbd2db3 100644 --- a/runtime/lua/vim/lsp/rpc.lua +++ b/runtime/lua/vim/lsp/rpc.lua @@ -550,7 +550,7 @@ local function new_client(dispatchers, transport) end ---@class vim.lsp.rpc.PublicClient ----@field request fun(method: string, params: table?, callback: fun(err: lsp.ResponseError|nil, result: any), notify_reply_callback: fun(integer)|nil):boolean,integer? see |vim.lsp.rpc.request()| +---@field request fun(method: string, params: table?, callback: fun(err: lsp.ResponseError|nil, result: any), notify_reply_callback: fun(message_id: integer)|nil):boolean,integer? see |vim.lsp.rpc.request()| ---@field notify fun(method: string, params: any):boolean see |vim.lsp.rpc.notify()| ---@field is_closing fun(): boolean ---@field terminate fun() |