aboutsummaryrefslogtreecommitdiff
path: root/src/nvim/api/vim.c
diff options
context:
space:
mode:
authorJustin M. Keyes <justinkz@gmail.com>2024-04-30 05:12:51 -0700
committerGitHub <noreply@github.com>2024-04-30 05:12:51 -0700
commit0330dd9e69de7567fd2479c0203b778a1d2dce2f (patch)
tree3ff04490ad0139292562db1b94178084f02d6459 /src/nvim/api/vim.c
parent71cf75f96a67aeb79ac3af6aa829bac81bd2d33d (diff)
downloadrneovim-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 'src/nvim/api/vim.c')
-rw-r--r--src/nvim/api/vim.c14
1 files changed, 6 insertions, 8 deletions
diff --git a/src/nvim/api/vim.c b/src/nvim/api/vim.c
index e4e4ae29f2..8458611ee8 100644
--- a/src/nvim/api/vim.c
+++ b/src/nvim/api/vim.c
@@ -2282,20 +2282,18 @@ void nvim_error_event(uint64_t channel_id, Integer lvl, String data)
ELOG("async error on channel %" PRId64 ": %s", channel_id, data.size ? data.data : "");
}
-/// 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.
+/// EXPERIMENTAL: this api may change in the future.
///
-/// @param index the completion candidate index
+/// 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 Completion candidate index
/// @param opts Optional parameters.
/// - info: (string) info text.
/// @return Dictionary containing these keys:
/// - winid: (number) floating window id
/// - bufnr: (number) buffer id in floating window
-Dictionary nvim_complete_set(Integer index, Dict(complete_set) *opts, Arena *arena)
- FUNC_API_SINCE(12)
+Dictionary nvim__complete_set(Integer index, Dict(complete_set) *opts, Arena *arena)
{
Dictionary rv = arena_dict(arena, 2);
if (HAS_KEY(opts, complete_set, info)) {