diff options
Diffstat (limited to 'runtime')
| -rw-r--r-- | runtime/doc/api.txt | 32 | ||||
| -rw-r--r-- | runtime/doc/news.txt | 3 | ||||
| -rw-r--r-- | runtime/lua/vim/_meta/api.lua | 23 |
3 files changed, 33 insertions, 25 deletions
diff --git a/runtime/doc/api.txt b/runtime/doc/api.txt index 463301693d..e564b19fc3 100644 --- a/runtime/doc/api.txt +++ b/runtime/doc/api.txt @@ -584,6 +584,23 @@ created for extmark changes. ============================================================================== Global Functions *api-global* +nvim__complete_set({index}, {opts}) *nvim__complete_set()* + EXPERIMENTAL: this api may change in the future. + + Sets info for the completion item at the given index. If the info text was + shown in a window, returns the window and buffer ids, or empty dict if not + shown. + + Parameters: ~ + • {index} Completion candidate index + • {opts} Optional parameters. + • info: (string) info text. + + Return: ~ + Dictionary containing these keys: + • winid: (number) floating window id + • bufnr: (number) buffer id in floating window + nvim__get_runtime({pat}, {all}, {opts}) *nvim__get_runtime()* Find files in runtime directories @@ -678,21 +695,6 @@ nvim_chan_send({chan}, {data}) *nvim_chan_send()* • {chan} id of the channel • {data} data to write. 8-bit clean: can contain NUL bytes. -nvim_complete_set({index}, {opts}) *nvim_complete_set()* - Set info for the completion candidate index. if the info was shown in a - window, then the window and buffer ids are returned for further - customization. If the text was not shown, an empty dict is returned. - - Parameters: ~ - • {index} the completion candidate index - • {opts} Optional parameters. - • info: (string) info text. - - Return: ~ - Dictionary containing these keys: - • winid: (number) floating window id - • bufnr: (number) buffer id in floating window - nvim_create_buf({listed}, {scratch}) *nvim_create_buf()* Creates a new, empty, unnamed buffer. diff --git a/runtime/doc/news.txt b/runtime/doc/news.txt index 692554295c..57f0f1d6d4 100644 --- a/runtime/doc/news.txt +++ b/runtime/doc/news.txt @@ -174,6 +174,9 @@ cycle (Nvim HEAD, the "master" branch). • Removed Iter:nthback(), use Iter:nth() with negative index instead. +• Renamed nvim_complete_set to nvim__complete_set and marked it as + experimental. + ============================================================================== NEW FEATURES *news-features* diff --git a/runtime/lua/vim/_meta/api.lua b/runtime/lua/vim/_meta/api.lua index 7d20d90990..58fa9af8cd 100644 --- a/runtime/lua/vim/_meta/api.lua +++ b/runtime/lua/vim/_meta/api.lua @@ -24,6 +24,19 @@ function vim.api.nvim__buf_redraw_range(buffer, first, last) end function vim.api.nvim__buf_stats(buffer) end --- @private +--- EXPERIMENTAL: this api may change in the future. +--- +--- Sets info for the completion item at the given index. If the info text was +--- shown in a window, returns the window and buffer ids, or empty dict if not +--- shown. +--- +--- @param index integer Completion candidate index +--- @param opts vim.api.keyset.complete_set Optional parameters. +--- • info: (string) info text. +--- @return table<string,any> +function vim.api.nvim__complete_set(index, opts) end + +--- @private --- @return string function vim.api.nvim__get_lib_dir() end @@ -822,16 +835,6 @@ function vim.api.nvim_command(command) end --- @return string function vim.api.nvim_command_output(command) end ---- Set info for the completion candidate index. if the info was shown in a ---- window, then the window and buffer ids are returned for further ---- customization. If the text was not shown, an empty dict is returned. ---- ---- @param index integer the completion candidate index ---- @param opts vim.api.keyset.complete_set Optional parameters. ---- • info: (string) info text. ---- @return table<string,any> -function vim.api.nvim_complete_set(index, opts) end - --- Create or get an autocommand group `autocmd-groups`. --- --- To get an existing group id, do: |