docs: misc

Co-authored-by: Au. <acehinnnqru@gmail.com>
Co-authored-by: Daniel Rainer <daniel.rainer@localhost>
Co-authored-by: Evgeni Chasnovski <evgeni.chasnovski@gmail.com>
Co-authored-by: Lewis Russell <lewis6991@gmail.com>
Co-authored-by: Luuk van Baal <luukvbaal@gmail.com>
Co-authored-by: Pierre Barbin <pierre@heitzsystem.com>
Co-authored-by: Riley Bruins <ribru17@hotmail.com>
Co-authored-by: Yinzuo Jiang <jiangyinzuo@foxmail.com>
Co-authored-by: phanium <91544758+phanen@users.noreply.github.com>
Co-authored-by: zeertzjq <zeertzjq@outlook.com>

.github/workflows/notes.md

@@ -36,7 +36,7 @@ Note: On Windows "Server" you may need to [install vcruntime140.dll](https://lea
 
 ### Linux (x86_64)
 
-glibc 2.35 or newer is required. Or you may try the (unsupported) [builds for older glibc](https://github.com/neovim/neovim-releases).
+If your system does not have the [required glibc version](https://neovim.io/doc/user/support.html#supported-platforms), try the (unsupported) [builds for older glibc](https://github.com/neovim/neovim-releases).
 
 #### AppImage
 

MAINTAIN.md

@@ -241,4 +241,4 @@ See also
 --------
 
 * https://github.com/neovim/neovim/issues/862
-* https://github.com/git/git/blob/master/Documentation/howto/maintain-git.txt
+* https://github.com/git/git/blob/master/Documentation/howto/maintain-git.adoc

runtime/doc/api.txt

@@ -2924,8 +2924,7 @@ nvim_buf_set_extmark({buffer}, {ns_id}, {line}, {col}, {opts})
                       'nowrap', otherwise the same as "trunc".
                   • ephemeral : for use with |nvim_set_decoration_provider()|
                     callbacks. The mark will only be used for the current
-                    redraw cycle, and not be permantently stored in the
+                    redraw cycle, and not be permanently stored in the buffer.
-                    buffer.
                   • right_gravity : boolean that indicates the direction the
                     extmark will be shifted in when new text is inserted (true
                     for right, false for left). Defaults to true.

runtime/doc/builtin.txt

@@ -6462,7 +6462,7 @@ matchfuzzy({list}, {str} [, {dict}])                              *matchfuzzy()*
                 Parameters: ~
                   • {list} (`any[]`)
                   • {str} (`string`)
-                  • {dict} (`string?`)
+                  • {dict} (`table?`)
 
                 Return: ~
                   (`any`)
@@ -6492,7 +6492,7 @@ matchfuzzypos({list}, {str} [, {dict}])                        *matchfuzzypos()*
                 Parameters: ~
                   • {list} (`any[]`)
                   • {str} (`string`)
-                  • {dict} (`string?`)
+                  • {dict} (`table?`)
 
                 Return: ~
                   (`any`)

runtime/doc/diagnostic.txt

@@ -122,7 +122,7 @@ with |vim.notify()|: >lua
     -- Users can configure the handler
     vim.diagnostic.config({
       ["my/notify"] = {
-        log_level = vim.log.levels.INFO
+        log_level = vim.log.levels.INFO,
 
         -- This handler will only receive "error" diagnostics.
         severity = vim.diagnostic.severity.ERROR,

runtime/doc/lua.txt

@@ -4288,7 +4288,7 @@ Iter:last()                                                      *Iter:last()*
         (`any`)
 
     See also: ~
-      • Iter.rpeek
+      • |Iter:rpeek()|
 
 Iter:map({f})                                                     *Iter:map()*
     Maps the items of an iterator pipeline to the values returned by `f`.
@@ -4425,7 +4425,7 @@ Iter:rfind({f})                                                 *Iter:rfind()*
         (`any`)
 
     See also: ~
-      • Iter.find
+      • |Iter:find()|
 
 Iter:rpeek()                                                    *Iter:rpeek()*
     Gets the last value of a |list-iterator| without consuming it.
@@ -4444,7 +4444,7 @@ Iter:rpeek()                                                    *Iter:rpeek()*
         (`any`)
 
     See also: ~
-      • Iter.last
+      • |Iter:last()|
 
 Iter:rskip({n})                                                 *Iter:rskip()*
     Discards `n` values from the end of a |list-iterator| pipeline.

runtime/doc/luaref.txt

@@ -3905,7 +3905,7 @@ package.cpath                                                    *package.cpath*
         variable `LUA_CPATH` (plus another default path defined in
         `luaconf.h`).
 
-package.loaded                                                *package.loaded()*
+package.loaded                                                  *package.loaded*
         A table used by `require` to control which modules are already loaded.
         When you require a module `modname` and `package.loaded[modname]` is
         not false, `require` simply returns the value stored there.

runtime/doc/sign.txt

@@ -123,8 +123,8 @@ See |sign_define()| for the equivalent Vim script function.
 
 	numhl={group}
 		Highlighting group used for the line number on the line where
-		the sign is placed.  Overrides |hl-LineNr|, |hl-LineNrAbove|,
+		the sign is placed.  Combines with |hl-LineNr|,
-		|hl-LineNrBelow|, and |hl-CursorLineNr|.
+		|hl-LineNrAbove|, |hl-LineNrBelow|, and |hl-CursorLineNr|.
 
 	text={text}						*E239*
 		Define the text that is displayed when there is no icon or the

runtime/doc/syntax.txt

@@ -336,7 +336,7 @@ Upon loading a file, Vim finds the relevant syntax file as follows:
 ==============================================================================
 4. Conversion to HTML				*convert-to-HTML* *2html.vim*
 
-The old to html converter has ben replaced by a Lua version and the
+The old to html converter has been replaced by a Lua version and the
 documentation has been moved to |:TOhtml|.
 
 ==============================================================================

runtime/doc/windows.txt

@@ -1272,7 +1272,7 @@ list of buffers. |unlisted-buffer|
 			:w foobar | sp #
 <		Also see |+cmd|.
 
-:[N]bn[ext][!] [+cmd] [N]				*:bn* *:bnext* *[b* *E87*
+:[N]bn[ext][!] [+cmd] [N]				*:bn* *:bnext* *]b* *E87*
 		Go to [N]th next buffer in buffer list.  [N] defaults to one.
 		Wraps around the end of the buffer list.
 		See |:buffer-!| for [!].
@@ -1290,7 +1290,7 @@ list of buffers. |unlisted-buffer|
 		Wraps around the end of the buffer list.  Uses 'switchbuf'
 		Also see |+cmd|.
 
-:[N]bN[ext][!] [+cmd] [N]		*:bN* *:bNext* *:bp* *:bprevious* *]b* *E88*
+:[N]bN[ext][!] [+cmd] [N]		*:bN* *:bNext* *:bp* *:bprevious* *[b* *E88*
 :[N]bp[revious][!] [+cmd] [N]
 		Go to [N]th previous buffer in buffer list.  [N] defaults to
 		one.  Wraps around the start of the buffer list.

runtime/lua/vim/_meta/api.lua

@@ -630,8 +630,7 @@ function vim.api.nvim_buf_line_count(buffer) end
 ---      otherwise the same as "trunc".
 --- - ephemeral : for use with `nvim_set_decoration_provider()`
 ---     callbacks. The mark will only be used for the current
----     redraw cycle, and not be permantently stored in the
+---     redraw cycle, and not be permanently stored in the buffer.
----     buffer.
 --- - right_gravity : boolean that indicates the direction
 ---     the extmark will be shifted in when new text is inserted
 ---     (true for right, false for left). Defaults to true.

runtime/lua/vim/_meta/builtin_types.lua

@@ -259,12 +259,12 @@
 --- write.  The number is the write count.  The
 --- first write has number 1, the last one the
 --- "save_last" mentioned above.
---- @field save integer
+--- @field save? integer
 ---
 --- Alternate entry.  This is again a List of undo
 --- blocks.  Each item may again have an "alt"
 --- item.
---- @field alt vim.fn.undotree.entry[]
+--- @field alt? vim.fn.undotree.entry[]
 
 --- @class vim.fn.undotree.ret
 ---

runtime/lua/vim/_meta/vimfn.lua

@@ -5868,7 +5868,7 @@ function vim.fn.matchend(expr, pat, start, count) end
 ---
 --- @param list any[]
 --- @param str string
---- @param dict? string
+--- @param dict? table
 --- @return any
 function vim.fn.matchfuzzy(list, str, dict) end
 
@@ -5895,7 +5895,7 @@ function vim.fn.matchfuzzy(list, str, dict) end
 ---
 --- @param list any[]
 --- @param str string
---- @param dict? string
+--- @param dict? table
 --- @return any
 function vim.fn.matchfuzzypos(list, str, dict) end
 

runtime/lua/vim/iter.lua

@@ -652,7 +652,7 @@ end
 ---
 --- ```
 ---
----@see Iter.find
+---@see |Iter:find()|
 ---
 ---@param f any
 ---@return any
@@ -757,7 +757,7 @@ end
 --- -- 4
 --- ```
 ---
----@see Iter.last
+---@see |Iter:last()|
 ---
 ---@return any
 function Iter:rpeek()
@@ -942,7 +942,7 @@ end
 ---
 --- ```
 ---
----@see Iter.rpeek
+---@see |Iter:rpeek()|
 ---
 ---@return any
 function Iter:last()

runtime/lua/vim/shared.lua

@@ -7,7 +7,8 @@
 -- so this wouldn't be a separate case to consider)
 
 ---@nodoc
-_G.vim = _G.vim or {} --[[@as table]] -- TODO(lewis6991): better fix for flaky luals
+_G.vim = _G.vim or {} --[[@as table]]
+-- TODO(lewis6991): better fix for flaky luals
 
 ---@generic T
 ---@param orig T

src/nvim/api/extmark.c

@@ -455,8 +455,7 @@ Array nvim_buf_get_extmarks(Buffer buffer, Integer ns_id, Object start, Object e
 ///                    otherwise the same as "trunc".
 ///               - ephemeral : for use with |nvim_set_decoration_provider()|
 ///                   callbacks. The mark will only be used for the current
-///                   redraw cycle, and not be permantently stored in the
+///                   redraw cycle, and not be permanently stored in the buffer.
-///                   buffer.
 ///               - right_gravity : boolean that indicates the direction
 ///                   the extmark will be shifted in when new text is inserted
 ///                   (true for right, false for left). Defaults to true.

src/nvim/buffer_defs.h

@@ -916,7 +916,7 @@ typedef enum {
 
 typedef enum {
   kWinStyleUnused = 0,
-  kWinStyleMinimal,  /// Minimal UI: no number column, eob markers, etc
+  kWinStyleMinimal,  ///< Minimal UI: no number column, eob markers, etc
 } WinStyle;
 
 typedef enum {

src/nvim/eval.lua

@@ -7200,7 +7200,7 @@ M.funcs = {
       <results in `['two one']`.
     ]=],
     name = 'matchfuzzy',
-    params = { { 'list', 'any[]' }, { 'str', 'string' }, { 'dict', 'string' } },
+    params = { { 'list', 'any[]' }, { 'str', 'string' }, { 'dict', 'table' } },
     signature = 'matchfuzzy({list}, {str} [, {dict}])',
   },
   matchfuzzypos = {
@@ -7229,7 +7229,7 @@ M.funcs = {
       <results in `[[{"id": 10, "text": "hello"}], [[2, 3]], [127]]`
     ]=],
     name = 'matchfuzzypos',
-    params = { { 'list', 'any[]' }, { 'str', 'string' }, { 'dict', 'string' } },
+    params = { { 'list', 'any[]' }, { 'str', 'string' }, { 'dict', 'table' } },
     signature = 'matchfuzzypos({list}, {str} [, {dict}])',
   },
   matchlist = {

src/nvim/mapping.c

@@ -104,14 +104,14 @@ struct map_arguments {
   char alt_lhs[MAXMAPLEN + 1];
   size_t alt_lhs_len;
 
-  char *rhs;  /// The {rhs} of the mapping.
+  char *rhs;  ///< The {rhs} of the mapping.
   size_t rhs_len;
-  LuaRef rhs_lua;  /// lua function as {rhs}
+  LuaRef rhs_lua;  ///< lua function as {rhs}
-  bool rhs_is_noop;  /// True when the {rhs} should be <Nop>.
+  bool rhs_is_noop;  ///< True when the {rhs} should be <Nop>.
 
-  char *orig_rhs;  /// The original text of the {rhs}.
+  char *orig_rhs;  ///< The original text of the {rhs}.
   size_t orig_rhs_len;
-  char *desc;  /// map description
+  char *desc;  ///< map description
 };
 typedef struct map_arguments MapArguments;
 #define MAP_ARGUMENTS_INIT { false, false, false, false, false, false, false, false, \

src/nvim/ui_defs.h

@@ -37,8 +37,8 @@ typedef struct {
   bool ui_ext[kUIExtCount];  ///< Externalized UI capabilities.
   int width;
   int height;
-  int pum_nlines;  /// actual nr. lines shown in PUM
+  int pum_nlines;  ///< actual nr. lines shown in PUM
-  bool pum_pos;  /// UI reports back pum position?
+  bool pum_pos;  ///< UI reports back pum position?
   double pum_row;
   double pum_col;
   double pum_height;

test/functional/legacy/messages_spec.lua

@@ -88,7 +88,7 @@ describe('messages', function()
   end)
 
   -- oldtest: Test_mode_cleared_after_silent_message()
-  it('mode is cleared properly after slient message', function()
+  it('mode is cleared properly after silent message', function()
     screen = Screen.new(60, 10)
     exec([[
       edit XsilentMessageMode.txt

test/functional/plugin/lsp/folding_range_spec.lua

@@ -612,7 +612,7 @@ static int foldLevel(linenr_T lnum)
       })
     end)
 
-    it('is defered when the buffer is not up-to-date', function()
+    it('is deferred when the buffer is not up-to-date', function()
       exec_lua(function()
         vim.lsp.foldclose('comment')
         vim.lsp.util.buf_versions[bufnr] = 0

test/functional/ui/cmdline_highlight_spec.lua

@@ -477,7 +477,7 @@ describe('Command-line coloring', function()
       :++^                                     |
     ]])
   end)
-  it('does not error out when called from a errorred out cycle', function()
+  it('does not error out when called from a errored out cycle', function()
     set_color_cb('ReturningGlobal', { { 0, 1, 'Normal' } })
     feed(dedent([[
       :set regexpengine=2
@@ -628,7 +628,7 @@ describe('Ex commands coloring', function()
     local msg = 'E5405: Chunk 0 start 10 splits multibyte character'
     eq('\n' .. msg, fn.execute('messages'))
   end)
-  it('does not error out when called from a errorred out cycle', function()
+  it('does not error out when called from a errored out cycle', function()
     -- Apparently when there is a cycle in which one of the commands errors out
     -- this error may be caught by color_cmdline before it is presented to the
     -- user.