docs: make docstring consistent with parameters #18178

Closes: https://github.com/neovim/neovim/issues/12691
This commit is contained in:
dundargoc
2022-04-24 02:01:01 +02:00
committed by GitHub
parent cfaf7440fc
commit 92f7286377
3 changed files with 12 additions and 13 deletions

View File

@@ -538,9 +538,9 @@ nvim__get_runtime({pat}, {all}, {*opts}) *nvim__get_runtime()*
{fast} {fast}
Parameters: ~ Parameters: ~
{pat} pattern of files to search for {pat} pattern of files to search for
{all} whether to return all matches or only the first {all} whether to return all matches or only the first
{options} is_lua: only search lua subdirs {opts} is_lua: only search lua subdirs
Return: ~ Return: ~
list of absolute paths to the found files 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. only.
Parameters: ~ Parameters: ~
{buffer} Buffer handle, or 0 for current buffer {buffer} Buffer handle, or 0 for current buffer
{start_row} First line index {start_row} First line index
{start_column} First column {start_col} First column
{end_row} Last line index {end_row} Last line index
{end_column} Last column {end_col} Last column
{replacement} Array of lines to use as replacement {replacement} Array of lines to use as replacement
nvim_buf_set_var({buffer}, {name}, {value}) *nvim_buf_set_var()* nvim_buf_set_var({buffer}, {name}, {value}) *nvim_buf_set_var()*
Sets a buffer-scoped (b:) variable Sets a buffer-scoped (b:) variable

View File

@@ -529,9 +529,9 @@ end:
/// @param channel_id /// @param channel_id
/// @param buffer Buffer handle, or 0 for current buffer /// @param buffer Buffer handle, or 0 for current buffer
/// @param start_row First line index /// @param start_row First line index
/// @param start_column First column /// @param start_col First column
/// @param end_row Last line index /// @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 replacement Array of lines to use as replacement
/// @param[out] err Error details, if any /// @param[out] err Error details, if any
void nvim_buf_set_text(uint64_t channel_id, Buffer buffer, Integer start_row, Integer start_col, void nvim_buf_set_text(uint64_t channel_id, Buffer buffer, Integer start_row, Integer start_col,

View File

@@ -526,8 +526,7 @@ String nvim__get_lib_dir(void)
/// ///
/// @param pat pattern of files to search for /// @param pat pattern of files to search for
/// @param all whether to return all matches or only the first /// @param all whether to return all matches or only the first
/// @param options /// @param opts is_lua: only search lua subdirs
/// is_lua: only search lua subdirs
/// @return list of absolute paths to the found files /// @return list of absolute paths to the found files
ArrayOf(String) nvim__get_runtime(Array pat, Boolean all, Dict(runtime) *opts, Error *err) ArrayOf(String) nvim__get_runtime(Array pat, Boolean all, Dict(runtime) *opts, Error *err)
FUNC_API_SINCE(8) FUNC_API_SINCE(8)