fix(api): mark nvim__complete_set as experimental #28579

Problem:
nvim_complete_set was added in 5ed55ff14c
but needs more bake time.

Solution:
Rename it, mark it as experimental.
This commit is contained in:
Justin M. Keyes
2024-04-30 05:12:51 -07:00
committed by GitHub
parent 71cf75f96a
commit 0330dd9e69
6 changed files with 42 additions and 36 deletions

View File

@@ -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)) {