docs: typo fixes (#17859)

Co-authored-by: Elias Alves Moura <eliamoura.alves@gmail.com> Co-authored-by: venkatesh <shariharanvenkatesh@gmail.com> Co-authored-by: zeertzjq <zeertzjq@outlook.com> Co-authored-by: Vikas Raj <24727447+numToStr@users.noreply.github.com> Co-authored-by: Steve Vermeulen <sfvermeulen@gmail.com> Co-authored-by: Evgeni Chasnovski <evgeni.chasnovski@gmail.com> Co-authored-by: rwxd <rwxd@pm.me> Co-authored-by: casswedson <58050969+casswedson@users.noreply.github.com>
2024-09-17 20:58:20 -04:00 · 2022-04-15 12:35:06 +02:00 · 2022-04-15 12:35:06 +02:00 · e63e5d1dbd
commit e63e5d1dbd
parent 4503cb6b64
39 changed files with 48 additions and 54 deletions
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@ -11,7 +11,7 @@ low-risk/isolated tasks:
 - Fix bugs found by [Clang](#clang-scan-build), [PVS](#pvs-studio) or
  [Coverity](#coverity).
 - [Improve documentation][wiki-contribute-help]
- [Merge a Vim patch] (Familiarity with Vim is *strongly* recommended)
+- [Merge a Vim patch] (familiarity with Vim is *strongly* recommended)

 Reporting problems
 ------------------
@ -289,7 +289,7 @@ as context, use the `-W` argument as well.
 [complexity:low]: https://github.com/neovim/neovim/issues?q=is%3Aopen+is%3Aissue+label%3Acomplexity%3Alow
 [master error list]: https://raw.githubusercontent.com/neovim/doc/gh-pages/reports/clint/errors.json
 [wiki-contribute-help]: https://github.com/neovim/neovim/wiki/contribute-%3Ahelp
-[pr-draft]: https://docs.github.com/en/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request
+[pr-draft]: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request
 [pr-ready]: https://docs.github.com/en/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request
 [uncrustify]: http://uncrustify.sourceforge.net/
 [lua-language-server]: https://github.com/sumneko/lua-language-server/
--- a/MAINTAIN.md
+++ b/MAINTAIN.md
@ -52,7 +52,7 @@ has a major bug:
 3. Cut a release from `release-x.y`.
    - Run `./scripts/release.sh`
    - Update (force-push) the remote `stable` tag.
-    - The [nightly job](https://github.com/neovim/bot-ci/blob/master/ci/nightly.sh)
+    - The [nightly job](https://github.com/neovim/neovim/blob/master/.github/workflows/release.yml#L4)
      will update the release assets based on the `stable` tag.

 The neovim repository includes a backport [github action](https://github.com/zeebe-io/backport-action).
--- a/runtime/doc/api.txt
+++ b/runtime/doc/api.txt
@ -2859,8 +2859,7 @@ nvim_win_set_cursor({window}, {pos})                   *nvim_win_set_cursor()*
                    {pos}     (row, col) tuple representing the new position

 nvim_win_set_height({window}, {height})                *nvim_win_set_height()*
-                Sets the window height. This will only succeed if the screen
-                is split horizontally.
+                Sets the window height.

                Parameters: ~
                    {window}  Window handle, or 0 for current window
@ -3234,9 +3233,9 @@ nvim_create_autocmd({event}, {*opts})                  *nvim_create_autocmd()*
                  pattern = { "*.py", "*.pyi" }
 <

-                Examples values for event: >
-                  "BufPreWrite"
-                  {"CursorHold", "BufPreWrite", "BufPostWrite"}
+                Example values for event: >
+                  "BufWritePre"
+                  {"CursorHold", "BufWritePre", "BufWritePost"}
 <

                Parameters: ~
--- a/runtime/doc/builtin.txt
+++ b/runtime/doc/builtin.txt
@ -966,8 +966,6 @@ byteidxcomp({expr}, {nr})					*byteidxcomp()*
 <		The first and third echo result in 3 ('e' plus composing
 		character is 3 bytes), the second echo results in 1 ('e' is
 		one byte).
-		Only works differently from byteidx() when 'encoding' is set
-		to a Unicode encoding.

 		Can also be used as a |method|: >
 			GetName()->byteidxcomp(idx)
--- a/runtime/doc/lua.txt
+++ b/runtime/doc/lua.txt
@ -1151,7 +1151,7 @@ In any of the above examples, to replicate the behavior |setlocal|, use

 |vim.opt| returns an Option object.

-For example: `local listchar_object = vim.opt.listchar`
+For example: `local listchar_object = vim.opt.listchars`

 An `Option` has the following methods:

@ -1910,7 +1910,7 @@ select({items}, {opts}, {on_choice})                         *vim.ui.select()*
                                   which select() was called.
                    {on_choice}  function ((item|nil, idx|nil) -> ()) Called
                                 once the user made a choice. `idx` is the
-                                 1-based index of `item` within `item`. `nil`
+                                 1-based index of `item` within `items`. `nil`
                                 if the user aborted the dialog.


--- a/runtime/doc/options.txt
+++ b/runtime/doc/options.txt
@ -921,7 +921,7 @@ A jump table for the options with a short description can be found at |Q_op|.

 	Note that environment variables are not expanded.  If you want to use
 	$HOME you must expand it explicitly, e.g.: >
-		:let backupskip = escape(expand('$HOME'), '\') .. '/tmp/*'
+		:let &backupskip = escape(expand('$HOME'), '\') .. '/tmp/*'

 <	Note that the default also makes sure that "crontab -e" works (when a
 	backup would be made by renaming the original file crontab won't see
--- a/runtime/doc/term.txt
+++ b/runtime/doc/term.txt
@ -111,7 +111,7 @@ width of the terminal.
 							*tui-input*
 Nvim uses libtermkey to convert terminal escape sequences to key codes.
 |terminfo| is used first, and CSI sequences not in |terminfo| (including
-exteneded keys a.k.a. modifyOtherKeys or `CSI u`) can also be parsed.
+extended keys a.k.a. modifyOtherKeys or `CSI u`) can also be parsed.
 For example, when running Nvim in tmux, this makes Nvim leave Insert mode and
 go to the window below: >
  tmux send-keys 'Escape' [ 2 7 u 'C-W' j
--- a/runtime/doc/treesitter.txt
+++ b/runtime/doc/treesitter.txt
@ -268,7 +268,7 @@ Here is a list of built-in directives:
 			((identifier) @foo (#set! @foo "kind" "parameter"))
 			((node1) @left (node2) @right (#set! "type" "pair"))
 <
-	`offset!`					*ts-predicate-offset!*
+	`offset!`					*ts-directive-offset!*
 		Takes the range of the captured node and applies the offsets
 		to it's range : >
 			((identifier) @constant (#offset! @constant 0 1 0 -1))
--- a/runtime/lua/vim/ui.lua
+++ b/runtime/lua/vim/ui.lua
@ -16,7 +16,7 @@ local M = {}
 ---               `items`, or the context in which select() was called.
 ---@param on_choice function ((item|nil, idx|nil) -> ())
 ---               Called once the user made a choice.
---               `idx` is the 1-based index of `item` within `item`.
+---               `idx` is the 1-based index of `item` within `items`.
 ---               `nil` if the user aborted the dialog.
 ---
 ---
--- a/scripts/lua2dox.lua
+++ b/scripts/lua2dox.lua
@ -295,7 +295,7 @@ function TStream_Write.writelnTail(this,Line)
  table.insert(this.tailLine,Line)
 end

--! \brief outout tail lines
+--! \brief output tail lines
 function TStream_Write.write_tailLines(this)
  for _,line in ipairs(this.tailLine) do
    TCore_IO_writeln(line)
--- a/src/nvim/README.md
+++ b/src/nvim/README.md
@ -68,7 +68,7 @@ Configure the sanitizer(s) via these environment variables:
    export ASAN_OPTIONS="detect_leaks=0:log_path=$HOME/logs/asan"
    # Show backtraces in the logs.
    export UBSAN_OPTIONS=print_stacktrace=1
-    export MSAN_OPTIONS="log_path=${HOME}/logs/tsan"
+    export MSAN_OPTIONS="log_path=${HOME}/logs/msan"
    export TSAN_OPTIONS="log_path=${HOME}/logs/tsan"

 Logs will be written to `${HOME}/logs/*san.PID` then.
--- a/src/nvim/api/autocmd.c
+++ b/src/nvim/api/autocmd.c
@ -360,10 +360,10 @@ cleanup:
 ///   pattern = { "*.py", "*.pyi" }
 /// </pre>
 ///
-/// Examples values for event:
+/// Example values for event:
 /// <pre>
-///   "BufPreWrite"
-///   {"CursorHold", "BufPreWrite", "BufPostWrite"}
+///   "BufWritePre"
+///   {"CursorHold", "BufWritePre", "BufWritePost"}
 /// </pre>
 ///
 /// @param event (string|array) The event or events to register this autocommand
--- a/src/nvim/api/window.c
+++ b/src/nvim/api/window.c
@ -139,8 +139,7 @@ Integer nvim_win_get_height(Window window, Error *err)
  return win->w_height;
 }

-/// Sets the window height. This will only succeed if the screen is split
-/// horizontally.
+/// Sets the window height.
 ///
 /// @param window   Window handle, or 0 for current window
 /// @param height   Height as a count of rows
--- a/src/nvim/ex_getln.c
+++ b/src/nvim/ex_getln.c
@ -5852,7 +5852,7 @@ HistoryType get_histtype(const char *const name, const size_t len, const bool re
 static int last_maptick = -1;           // last seen maptick

 /// Add the given string to the given history.  If the string is already in the
-/// history then it is moved to the front.  "histype" may be one of he HIST_
+/// history then it is moved to the front.  "histype" may be one of the HIST_
 /// values.
 ///
 /// @parma in_map  consider maptick when inside a mapping
--- a/src/nvim/highlight_group.c
+++ b/src/nvim/highlight_group.c
@ -446,7 +446,7 @@ const char *const highlight_init_cmdline[] = {

  "default link NvimInvalidSpacing ErrorMsg",

-  // Not actually invalid, but we highlight user that he is doing something
+  // Not actually invalid, but we show the user that they are doing something
  // wrong.
  "default link NvimDoubleQuotedUnknownEscape NvimInvalidValue",
  NULL,
--- a/src/nvim/memline.c
+++ b/src/nvim/memline.c
@ -3944,10 +3944,8 @@ static void ml_updatechunk(buf_T *buf, linenr_T line, long len, int updtype)
    } else if (buf->b_ml.ml_chunksize[curix].mlcs_numlines >= MLCS_MINL
               && curix == buf->b_ml.ml_usedchunks - 1
               && buf->b_ml.ml_line_count - line <= 1) {
-      /*
-       * We are in the last chunk and it is cheap to crate a new one
-       * after this. Do it now to avoid the loop above later on
-       */
+      // We are in the last chunk and it is cheap to create a new one
+      // after this. Do it now to avoid the loop above later on
      curchnk = buf->b_ml.ml_chunksize + curix + 1;
      buf->b_ml.ml_usedchunks++;
      if (line == buf->b_ml.ml_line_count) {
--- a/src/nvim/normal.c
+++ b/src/nvim/normal.c
@ -4533,7 +4533,7 @@ static void nv_scroll(cmdarg_T *cap)
      validate_botline(curwin);  // make sure w_empty_rows is valid
      half = (curwin->w_height_inner - curwin->w_empty_rows + 1) / 2;
      for (n = 0; curwin->w_topline + n < curbuf->b_ml.ml_line_count; n++) {
-        // Count half he number of filler lines to be "below this
+        // Count half the number of filler lines to be "below this
        // line" and half to be "above the next line".
        if (n > 0 && used + win_get_fill(curwin, curwin->w_topline + n) / 2 >= half) {
          n--;
--- a/src/nvim/screen.c
+++ b/src/nvim/screen.c
@ -4840,7 +4840,7 @@ static int get_corner_sep_connector(win_T *wp, WindowCorner corner)
  }
 }

-/// Draw seperator connecting characters on the corners of window "wp"
+/// Draw separator connecting characters on the corners of window "wp"
 static void draw_sep_connectors_win(win_T *wp)
 {
  // Don't draw separator connectors unless global statusline is enabled and the window has
--- a/src/nvim/screen.h
+++ b/src/nvim/screen.h
@ -27,7 +27,7 @@ typedef enum {
  WC_BOTTOM_RIGHT
 } WindowCorner;

-/// By default, all widows are draw on a single rectangular grid, represented by
+/// By default, all windows are drawn on a single rectangular grid, represented by
 /// this ScreenGrid instance. In multigrid mode each window will have its own
 /// grid, then this is only used for global screen elements that hasn't been
 /// externalized.
--- a/src/nvim/testdir/test_breakindent.vim
+++ b/src/nvim/testdir/test_breakindent.vim
@ -770,7 +770,7 @@ func Test_breakindent20_list()
 	\ "shall make no law   ",
 	\ ]
  call s:compare_lines(expect, lines)
-  " set mininum indent
+  " set minimum indent
  setl briopt=min:5
  redraw!
  let lines = s:screen_lines2(1, 6, 20)
--- a/src/nvim/testdir/test_cmdline.vim
+++ b/src/nvim/testdir/test_cmdline.vim
@ -1127,7 +1127,7 @@ func Test_cmdwin_tabpage()
  tabedit
  " v8.2.1919 isn't ported yet, so E492 is thrown after E11 here.
  " v8.2.1183 also isn't ported yet, so we also can't assert E11 directly.
-  " For now, assert E11 and E492 seperately. When v8.2.1183 is ported, the
+  " For now, assert E11 and E492 separately. When v8.2.1183 is ported, the
  " assert for E492 will fail and this workaround should be removed.
  " call assert_fails("silent norm q/g	:I\<Esc>", 'E11:')
  call assert_fails("silent norm q/g	", 'E11:')
--- a/src/nvim/testdir/test_debugger.vim
+++ b/src/nvim/testdir/test_debugger.vim
@ -976,7 +976,7 @@ func Test_debug_backtrace_level()
        \ 'line 1: let s:file1_var = ''file1'''
        \ ])

-  " step throught the initial declarations
+  " step through the initial declarations
  call RunDbgCmd(buf, 'step', [ 'line 2: let g:global_var = ''global''' ] )
  call RunDbgCmd(buf, 'step', [ 'line 4: func s:File1Func( arg )' ] )
  call RunDbgCmd(buf, 'echo s:file1_var', [ 'file1' ] )
--- a/src/nvim/testdir/test_increment.vim
+++ b/src/nvim/testdir/test_increment.vim
@ -285,7 +285,7 @@ endfunc
 " 1
 "     1
 "     1
-"     Expexted:
+"     Expected:
 "     1) g Ctrl-A on block selected indented lines
 "     2
 " 1
--- a/src/nvim/testdir/test_quickfix.vim
+++ b/src/nvim/testdir/test_quickfix.vim
@ -5049,7 +5049,7 @@ func Test_quickfix_window_fails_to_open()
  call delete('XquickfixFails')
 endfunc

-" Test for updating the quickfix buffer whenever the assocaited quickfix list
+" Test for updating the quickfix buffer whenever the associated quickfix list
 " is changed.
 func Xqfbuf_update(cchar)
  call s:setup_commands(a:cchar)
--- a/src/nvim/testdir/test_regexp_latin.vim
+++ b/src/nvim/testdir/test_regexp_latin.vim
@ -686,7 +686,7 @@ func Test_matchstr_with_ze()
  bwipe!
 endfunc

-" Check a pattern with a look beind crossing a line boundary
+" Check a pattern with a look behind crossing a line boundary
 func Test_lookbehind_across_line()
  new
  call append(0, ['Behind:', 'asdfasd<yyy', 'xxstart1', 'asdfasd<yy',
--- a/src/nvim/testdir/test_sort.vim
+++ b/src/nvim/testdir/test_sort.vim
@ -1356,7 +1356,7 @@ func Test_sort_cmd()
    endif
  endfor

-  " Needs atleast two lines for this test
+  " Needs at least two lines for this test
  call setline(1, ['line1', 'line2'])
  call assert_fails('sort no', 'E474:')
  call assert_fails('sort c', 'E475:')
--- a/test/functional/api/extmark_spec.lua
+++ b/test/functional/api/extmark_spec.lua
@ -924,7 +924,7 @@ describe('API/extmarks', function()
    eq(3, set_extmark(ns, 3, positions[2][1], positions[2][2]))
    eq(4, set_extmark(ns, 0, positions[1][1], positions[1][2]))

-    -- mixing manual and allocated id:s are not recommened, but it should
+    -- mixing manual and allocated id:s are not recommended, but it should
    -- do something reasonable
    eq(6, set_extmark(ns, 6, positions[2][1], positions[2][2]))
    eq(7, set_extmark(ns, 0, positions[1][1], positions[1][2]))
--- a/test/functional/api/highlight_spec.lua
+++ b/test/functional/api/highlight_spec.lua
@ -251,7 +251,7 @@ describe("API: set highlight", function()
    eq(highlight2_result, meths.get_hl_by_name('Test_hl', false))
  end)

-  it ("can set emtpy cterm attr", function()
+  it ("can set empty cterm attr", function()
    local ns = get_ns()
    meths.set_hl(ns, 'Test_hl', { cterm = {} })
    eq({}, meths.get_hl_by_name('Test_hl', false))
--- a/test/functional/core/job_spec.lua
+++ b/test/functional/core/job_spec.lua
@ -1038,7 +1038,7 @@ describe('jobs', function()
      local other_jobid = eval("jobstart(['cat', '-'], g:job_opts)")
      local other_pid = eval('jobpid(' .. other_jobid .. ')')

-      -- Other job doesn't block first job from recieving SIGHUP on jobclose()
+      -- Other job doesn't block first job from receiving SIGHUP on jobclose()
      command('call jobclose(j)')
      -- Have to wait so that the SIGHUP can be processed by tty-test on time.
      -- Can't wait for the next message in case this test fails, if it fails
--- a/test/functional/core/startup_spec.lua
+++ b/test/functional/core/startup_spec.lua
@ -358,7 +358,7 @@ describe('startup', function()
  end)

  it("handles :packadd during startup", function()
-    -- control group: opt/bonus is not availabe by default
+    -- control group: opt/bonus is not available by default
    pack_clear [[
      try
        let g:x = bonus#secret()
--- a/test/functional/ex_cmds/cd_spec.lua
+++ b/test/functional/ex_cmds/cd_spec.lua
@ -173,7 +173,7 @@ for _, cmd in ipairs {'cd', 'chdir'} do
      -- Change tab-local working directory and verify it is different
      command('silent t' .. cmd .. ' ' .. directories.tab)
      eq(globalDir .. pathsep .. directories.tab, cwd())
-      eq(cwd(), tcwd())  -- working directory maches tab directory
+      eq(cwd(), tcwd())  -- working directory matches tab directory
      eq(1, tlwd())
      eq(cwd(), wcwd())  -- still no window-directory
      eq(0, wlwd())
--- a/test/functional/terminal/highlight_spec.lua
+++ b/test/functional/terminal/highlight_spec.lua
@ -215,7 +215,7 @@ describe(':terminal highlight with custom palette', function()
    clear()
    screen = Screen.new(50, 7)
    screen:set_default_attr_ids({
-      [1] = {foreground = tonumber('0x123456')}, -- no fg_indexed when overriden
+      [1] = {foreground = tonumber('0x123456')}, -- no fg_indexed when overridden
      [2] = {foreground = 12},
      [3] = {bold = true, reverse = true},
      [5] = {background = 11},
--- a/test/functional/ui/decorations_spec.lua
+++ b/test/functional/ui/decorations_spec.lua
@ -728,7 +728,7 @@ end]]
    ]]}
  end)

-  it('can have virtual text which combines foreground and backround groups', function()
+  it('can have virtual text which combines foreground and background groups', function()
    screen:set_default_attr_ids {
      [1] = {bold=true, foreground=Screen.colors.Blue};
      [2] = {background = tonumber('0x123456'), foreground = tonumber('0xbbbbbb')};
--- a/test/functional/ui/messages_spec.lua
+++ b/test/functional/ui/messages_spec.lua
@ -1013,7 +1013,7 @@ vimComment     xxx match /\s"[^\-:.%#=*].*$/ms=s+1,lc=1  excludenl contains=@vim
  end)

  it('redraws NOT_VALID correctly after message', function()
-    -- edge case: only one window was set NOT_VALID. Orginal report
+    -- edge case: only one window was set NOT_VALID. Original report
    -- used :make, but fake it using one command to set the current
    -- window NOT_VALID and another to show a long message.
    command("set more")
@ -1227,7 +1227,7 @@ describe('ui/msg_puts_printf', function()
        pending('Locale ja_JP.UTF-8 not supported', function() end)
        return
      elseif helpers.isCI() then
-        -- Fails non--Windows CI. Message catalog direcotry issue?
+        -- Fails non--Windows CI. Message catalog directory issue?
        pending('fails on unix CI', function() end)
        return
      end
--- a/test/functional/ui/multibyte_spec.lua
+++ b/test/functional/ui/multibyte_spec.lua
@ -26,7 +26,7 @@ describe("multibyte rendering", function()
      ̊
      x]])
    feed("gg")
-     -- verify the modifier infact is alone
+     -- verify the modifier in fact is alone
    feed_command("ascii")
    screen:expect([[
      ^ ̊                                                           |
--- a/test/functional/ui/popupmenu_spec.lua
+++ b/test/functional/ui/popupmenu_spec.lua
@ -1952,7 +1952,7 @@ describe('builtin popupmenu', function()
    ]])
  end)

-  it('wildoptions=pum with scrolled mesages ', function()
+  it('wildoptions=pum with scrolled messages ', function()
    screen:try_resize(40,10)
    command('set wildmenu')
    command('set wildoptions=pum')
@ -2191,7 +2191,7 @@ describe('builtin popupmenu', function()
      {20:-- Keyword Local completion (^N^P) }{21:match 1 of 65}            |
    ]])

-    -- can disable blending for indiviual attribute. For instance current
+    -- can disable blending for individual attribute. For instance current
    -- selected item. (also tests that `hi Pmenu*` take immediate effect)
    command('hi PMenuSel blend=0')
    screen:expect([[
--- a/test/functional/ui/screen.lua
+++ b/test/functional/ui/screen.lua
@ -544,7 +544,7 @@ function Screen:_wait(check, flags)
  elseif not checked then
    err = check()
    if not err and flags.unchanged then
-      -- expecting NO screen change: use a shorter timout
+      -- expecting NO screen change: use a shorter timeout
      success_seen = true
    end
  end
--- a/test/functional/ui/searchhl_spec.lua
+++ b/test/functional/ui/searchhl_spec.lua
@ -471,7 +471,7 @@ describe('search highlighting', function()
      {4:search hit BOTTOM, continuing at TOP}    |
    ]])

-    -- check hilights work also in folds
+    -- check highlights work also in folds
    feed("zf4j")
    command("%foldopen")
    screen:expect([[
--- a/test/functional/vimscript/system_spec.lua
+++ b/test/functional/vimscript/system_spec.lua
@ -527,7 +527,7 @@ describe('systemlist()', function()
    end)

    -- Unlike `system()` which uses SOH to represent NULs, with `systemlist()`
-    -- input and ouput are the same.
+    -- input and output are the same.
    describe('with linefeed characters inside list items', function()
      it('converts linefeed characters to NULs', function()
        eq({'l1\np2', 'line2\na\nb', 'l3'},