From ff20d40321399fa187bd350f9619cf6418d7eb6e Mon Sep 17 00:00:00 2001 From: dundargoc <33953936+dundargoc@users.noreply.github.com> Date: Sat, 4 Jun 2022 05:56:36 +0200 Subject: [PATCH] docs: fix typos (#18269) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: zeertzjq Co-authored-by: Dan Sully Co-authored-by: saher Co-authored-by: Stephan Seitz Co-authored-by: Benedikt Müller Co-authored-by: Andrey Mishchenko Co-authored-by: Famiu Haque Co-authored-by: Oliver Marriott --- runtime/doc/api.txt | 3 +-- runtime/doc/lsp.txt | 2 +- runtime/doc/lua.txt | 2 +- runtime/doc/usr_05.txt | 2 +- runtime/lua/vim/lsp.lua | 2 +- runtime/optwin.vim | 2 +- src/nvim/api/vim.c | 1 - src/nvim/ex_getln.c | 1 - src/nvim/lua/treesitter.c | 2 +- src/nvim/move.c | 4 ++-- src/nvim/state.c | 2 +- test/functional/api/window_spec.lua | 2 +- test/functional/legacy/display_spec.lua | 2 +- test/functional/legacy/listchars_spec.lua | 2 +- test/functional/legacy/statusline_spec.lua | 2 +- test/functional/options/cursorbind_spec.lua | 2 +- 16 files changed, 15 insertions(+), 18 deletions(-) diff --git a/runtime/doc/api.txt b/runtime/doc/api.txt index 60d7528602..2c75acbe1f 100644 --- a/runtime/doc/api.txt +++ b/runtime/doc/api.txt @@ -1625,8 +1625,7 @@ nvim_set_hl({ns_id}, {name}, {*val}) *nvim_set_hl()* • reverse: boolean • nocombine: boolean • link: name of another highlight group to link - to, see |:hi-link|. Additionally, the following - keys are recognized: + to, see |:hi-link|. • default: Don't override existing definition |:hi-default| • ctermfg: Sets foreground of cterm color diff --git a/runtime/doc/lsp.txt b/runtime/doc/lsp.txt index 34ea5f39d6..4f07752cb6 100644 --- a/runtime/doc/lsp.txt +++ b/runtime/doc/lsp.txt @@ -987,7 +987,7 @@ start_client({config}) *vim.lsp.start_client()* default true): Allow using incremental sync for buffer edits • debounce_text_changes (number, - default nil): Debounce didChange + default 150): Debounce didChange notifications to the server by the given number in milliseconds. No debounce occurs if nil diff --git a/runtime/doc/lua.txt b/runtime/doc/lua.txt index 8a14f80856..bdd2e6ff8e 100644 --- a/runtime/doc/lua.txt +++ b/runtime/doc/lua.txt @@ -1092,7 +1092,7 @@ vim.env *vim.env* *lua-vim-optlocal* *lua-vim-setlocal* -In Vimscript, there is an way to set options |set-option|. In Lua, the +In Vimscript, there is a way to set options |set-option|. In Lua, the corresponding method is `vim.opt`. `vim.opt` provides several conveniences for setting and controlling options diff --git a/runtime/doc/usr_05.txt b/runtime/doc/usr_05.txt index 1cf383dce3..0e94d9a1b1 100644 --- a/runtime/doc/usr_05.txt +++ b/runtime/doc/usr_05.txt @@ -45,7 +45,7 @@ This file is always used and is recommended: The vimrc file can contain all the commands that you type after a colon. The simplest ones are for setting options. For example, if you want Vim to always -start with the 'incsearch' option on, add this line your vimrc file: > +start with the 'ignorecase' option on, add this line your vimrc file: > set ignorecase diff --git a/runtime/lua/vim/lsp.lua b/runtime/lua/vim/lsp.lua index 361bcec04b..8bf736a2ca 100644 --- a/runtime/lua/vim/lsp.lua +++ b/runtime/lua/vim/lsp.lua @@ -836,7 +836,7 @@ end --- server in the initialize request. Invalid/empty values will default to "off" ---@param flags: A table with flags for the client. The current (experimental) flags are: --- - allow_incremental_sync (bool, default true): Allow using incremental sync for buffer edits ---- - debounce_text_changes (number, default nil): Debounce didChange +--- - debounce_text_changes (number, default 150): Debounce didChange --- notifications to the server by the given number in milliseconds. No debounce --- occurs if nil --- - exit_timeout (number, default 500): Milliseconds to wait for server to diff --git a/runtime/optwin.vim b/runtime/optwin.vim index 54f57a260c..228336e5a4 100644 --- a/runtime/optwin.vim +++ b/runtime/optwin.vim @@ -469,7 +469,7 @@ endif call Header("multiple windows") -call append("$", "laststatus\t0, 1 or 2; when to use a status line for the last window") +call append("$", "laststatus\t0, 1, 2 or 3; when to use a status line for the last window") call append("$", " \tset ls=" . &ls) if has("statusline") call append("$", "statusline\talternate format to be used for a status line") diff --git a/src/nvim/api/vim.c b/src/nvim/api/vim.c index 2320ae62af..9430a37d27 100644 --- a/src/nvim/api/vim.c +++ b/src/nvim/api/vim.c @@ -157,7 +157,6 @@ Dictionary nvim__get_hl_defs(Integer ns_id, Error *err) /// - reverse: boolean /// - nocombine: boolean /// - link: name of another highlight group to link to, see |:hi-link|. -/// Additionally, the following keys are recognized: /// - default: Don't override existing definition |:hi-default| /// - ctermfg: Sets foreground of cterm color |highlight-ctermfg| /// - ctermbg: Sets background of cterm color |highlight-ctermbg| diff --git a/src/nvim/ex_getln.c b/src/nvim/ex_getln.c index 7507932b6f..ad3ccf2a99 100644 --- a/src/nvim/ex_getln.c +++ b/src/nvim/ex_getln.c @@ -2553,7 +2553,6 @@ static int command_line_changed(CommandLineState *s) } } - // 'incsearch' highlighting. if (s->firstc == ':' && current_sctx.sc_sid == 0 // only if interactive && *p_icm != NUL // 'inccommand' is set diff --git a/src/nvim/lua/treesitter.c b/src/nvim/lua/treesitter.c index 6ec9cfd21d..b96193d199 100644 --- a/src/nvim/lua/treesitter.c +++ b/src/nvim/lua/treesitter.c @@ -391,7 +391,7 @@ static int parser_parse(lua_State *L) return luaL_error(L, "An error occurred when parsing."); } - // The new tree will be pushed to the stack, without copy, owwership is now to + // The new tree will be pushed to the stack, without copy, ownership is now to // the lua GC. // Old tree is still owned by the lua GC. uint32_t n_ranges = 0; diff --git a/src/nvim/move.c b/src/nvim/move.c index 9f72b36638..8c927d30d1 100644 --- a/src/nvim/move.c +++ b/src/nvim/move.c @@ -108,14 +108,14 @@ void redraw_for_cursorline(win_T *wp) } /// Redraw when w_virtcol changes and 'cursorcolumn' is set or 'cursorlineopt' -/// contains "screenline" or when the 'CurSearch' highlight is in use. +/// contains "screenline" or when the "CurSearch" highlight is in use. /// Also when concealing is on and 'concealcursor' is active. static void redraw_for_cursorcolumn(win_T *wp) FUNC_ATTR_NONNULL_ALL { if ((wp->w_valid & VALID_VIRTCOL) == 0 && !pum_visible()) { if (wp->w_p_cuc || ((HL_ATTR(HLF_LC) || wp->w_hl_ids[HLF_LC]) && using_hlsearch())) { - // When 'cursorcolumn' is set or 'CurSearch' is in use + // When 'cursorcolumn' is set or "CurSearch" is in use // need to redraw with SOME_VALID. redraw_later(wp, SOME_VALID); } else if (wp->w_p_cul && (wp->w_p_culopt_flags & CULOPT_SCRLINE)) { diff --git a/src/nvim/state.c b/src/nvim/state.c index f075dd772a..6475105192 100644 --- a/src/nvim/state.c +++ b/src/nvim/state.c @@ -137,7 +137,7 @@ bool virtual_active(void) || ((cur_ve_flags & VE_INSERT) && (State & MODE_INSERT)); } -/// MODE_VISUAL, MODE_SELECTMODE and MODE_OP_PENDING State are never set, they are +/// MODE_VISUAL, MODE_SELECT and MODE_OP_PENDING State are never set, they are /// equal to MODE_NORMAL State with a condition. This function returns the real /// State. int get_real_state(void) diff --git a/test/functional/api/window_spec.lua b/test/functional/api/window_spec.lua index 9aacac37bf..901d24327c 100644 --- a/test/functional/api/window_spec.lua +++ b/test/functional/api/window_spec.lua @@ -153,7 +153,7 @@ describe('API/win', function() [1] = {bold = true, foreground = Screen.colors.Blue}, -- NonText [2] = {background = Screen.colors.Grey90}, -- CursorLine [3] = {bold = true, reverse = true}, -- StatusLine - [4] = {reverse = true}, -- VertSplit, StatusLineNC + [4] = {reverse = true}, -- StatusLineNC }) screen:attach() command('set ruler') diff --git a/test/functional/legacy/display_spec.lua b/test/functional/legacy/display_spec.lua index ccc709cbf6..f0ffaf2c48 100644 --- a/test/functional/legacy/display_spec.lua +++ b/test/functional/legacy/display_spec.lua @@ -61,7 +61,7 @@ describe('display', function() screen:set_default_attr_ids({ [1] = {bold = true, foreground = Screen.colors.Blue}, -- NonText [2] = {bold = true, reverse = true}, -- StatusLine - [3] = {reverse = true}, -- VertSplit, StatusLineNC + [3] = {reverse = true}, -- StatusLineNC }) screen:attach() exec([[ diff --git a/test/functional/legacy/listchars_spec.lua b/test/functional/legacy/listchars_spec.lua index a94ec431d4..a9aa238d4e 100644 --- a/test/functional/legacy/listchars_spec.lua +++ b/test/functional/legacy/listchars_spec.lua @@ -105,7 +105,7 @@ describe("'listchars'", function() screen:set_default_attr_ids({ [1] = {bold = true, foreground = Screen.colors.Blue}, -- NonText [2] = {bold = true, reverse = true}, -- StatusLine - [3] = {reverse = true}, -- StatusLineNC, VertSplit + [3] = {reverse = true}, -- StatusLineNC [4] = {background = Screen.colors.Grey, foreground = Screen.colors.DarkBlue}, -- FoldColumn, SignColumn }) screen:attach() diff --git a/test/functional/legacy/statusline_spec.lua b/test/functional/legacy/statusline_spec.lua index 5eb46077ec..e2b30a7c82 100644 --- a/test/functional/legacy/statusline_spec.lua +++ b/test/functional/legacy/statusline_spec.lua @@ -18,7 +18,7 @@ describe('statusline', function() screen:set_default_attr_ids({ [1] = {bold = true, foreground = Screen.colors.Blue}, -- NonText [2] = {bold = true, reverse = true}, -- StatusLine - [3] = {reverse = true}, -- StatusLineNC, VertSplit + [3] = {reverse = true}, -- StatusLineNC }) exec([[ setlocal statusline=-%{mode()}- diff --git a/test/functional/options/cursorbind_spec.lua b/test/functional/options/cursorbind_spec.lua index fcb753451c..1a03ed099a 100644 --- a/test/functional/options/cursorbind_spec.lua +++ b/test/functional/options/cursorbind_spec.lua @@ -13,7 +13,7 @@ describe("'cursorbind'", function() screen:set_default_attr_ids({ [1] = {bold = true, foreground = Screen.colors.Blue}, -- NonText [2] = {bold = true, reverse = true}, -- StatusLine - [3] = {reverse = true}, -- StatusLineNC, VertSplit + [3] = {reverse = true}, -- StatusLineNC [4] = {background = Screen.colors.Grey90}, -- CursorLine, CursorColumn }) screen:attach()