From 92f7286377cb077cb42484a83740a8c95f8ae7f1 Mon Sep 17 00:00:00 2001 From: dundargoc <33953936+dundargoc@users.noreply.github.com> Date: Sun, 24 Apr 2022 02:01:01 +0200 Subject: [PATCH] docs: make docstring consistent with parameters #18178 Closes: https://github.com/neovim/neovim/issues/12691 --- runtime/doc/api.txt | 18 +++++++++--------- src/nvim/api/buffer.c | 4 ++-- src/nvim/api/vim.c | 3 +-- 3 files changed, 12 insertions(+), 13 deletions(-) diff --git a/runtime/doc/api.txt b/runtime/doc/api.txt index 5b045f80ff..f4942d7f26 100644 --- a/runtime/doc/api.txt +++ b/runtime/doc/api.txt @@ -538,9 +538,9 @@ nvim__get_runtime({pat}, {all}, {*opts}) *nvim__get_runtime()* {fast} Parameters: ~ - {pat} pattern of files to search for - {all} whether to return all matches or only the first - {options} is_lua: only search lua subdirs + {pat} pattern of files to search for + {all} whether to return all matches or only the first + {opts} is_lua: only search lua subdirs Return: ~ list of absolute paths to the found files @@ -2325,12 +2325,12 @@ nvim_buf_set_text({buffer}, {start_row}, {start_col}, {end_row}, {end_col}, only. Parameters: ~ - {buffer} Buffer handle, or 0 for current buffer - {start_row} First line index - {start_column} First column - {end_row} Last line index - {end_column} Last column - {replacement} Array of lines to use as replacement + {buffer} Buffer handle, or 0 for current buffer + {start_row} First line index + {start_col} First column + {end_row} Last line index + {end_col} Last column + {replacement} Array of lines to use as replacement nvim_buf_set_var({buffer}, {name}, {value}) *nvim_buf_set_var()* Sets a buffer-scoped (b:) variable diff --git a/src/nvim/api/buffer.c b/src/nvim/api/buffer.c index 6d5803a5fe..0c68325f40 100644 --- a/src/nvim/api/buffer.c +++ b/src/nvim/api/buffer.c @@ -529,9 +529,9 @@ end: /// @param channel_id /// @param buffer Buffer handle, or 0 for current buffer /// @param start_row First line index -/// @param start_column First column +/// @param start_col First column /// @param end_row Last line index -/// @param end_column Last column +/// @param end_col Last column /// @param replacement Array of lines to use as replacement /// @param[out] err Error details, if any void nvim_buf_set_text(uint64_t channel_id, Buffer buffer, Integer start_row, Integer start_col, diff --git a/src/nvim/api/vim.c b/src/nvim/api/vim.c index 626f7dc3eb..7a966777af 100644 --- a/src/nvim/api/vim.c +++ b/src/nvim/api/vim.c @@ -526,8 +526,7 @@ String nvim__get_lib_dir(void) /// /// @param pat pattern of files to search for /// @param all whether to return all matches or only the first -/// @param options -/// is_lua: only search lua subdirs +/// @param opts is_lua: only search lua subdirs /// @return list of absolute paths to the found files ArrayOf(String) nvim__get_runtime(Array pat, Boolean all, Dict(runtime) *opts, Error *err) FUNC_API_SINCE(8)