diff options
author | Justin M. Keyes <justinkz@gmail.com> | 2024-04-30 05:12:51 -0700 |
---|---|---|
committer | GitHub <noreply@github.com> | 2024-04-30 05:12:51 -0700 |
commit | 0330dd9e69de7567fd2479c0203b778a1d2dce2f (patch) | |
tree | 3ff04490ad0139292562db1b94178084f02d6459 /runtime/doc/api.txt | |
parent | 71cf75f96a67aeb79ac3af6aa829bac81bd2d33d (diff) | |
download | rneovim-0330dd9e69de7567fd2479c0203b778a1d2dce2f.tar.gz rneovim-0330dd9e69de7567fd2479c0203b778a1d2dce2f.tar.bz2 rneovim-0330dd9e69de7567fd2479c0203b778a1d2dce2f.zip |
fix(api): mark nvim__complete_set as experimental #28579
Problem:
nvim_complete_set was added in 5ed55ff14c8b7e346811cb6228bf63fb5106bae9
but needs more bake time.
Solution:
Rename it, mark it as experimental.
Diffstat (limited to 'runtime/doc/api.txt')
-rw-r--r-- | runtime/doc/api.txt | 32 |
1 files changed, 17 insertions, 15 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. |