commit 08991b078267e5de0a19a136d00d4f71ad651a32 parent 1f33b2b1e873a9c39a1abeb446d7889e0bfb2557 Author: dundargoc <33953936+dundargoc@users.noreply.github.com> Date: Sat, 13 May 2023 21:33:22 +0200 docs: small fixes Co-authored-by: Christian Clason <c.clason@uni-graz.at> Co-authored-by: Gregory Anders <greg@gpanders.com> Co-authored-by: HiPhish <hiphish@posteo.de> Co-authored-by: Julio B <julio.bacel@gmail.com> Co-authored-by: T727 <74924917+T-727@users.noreply.github.com> Co-authored-by: camoz <camoz@users.noreply.github.com> Co-authored-by: champignoom <66909116+champignoom@users.noreply.github.com> Diffstat:
43 files changed, 98 insertions(+), 94 deletions(-)
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml @@ -143,7 +143,7 @@ jobs: - name: Install dependencies run: ./.github/scripts/install_deps.sh --test - - name: Setup interpreter packages + - name: Set up interpreter packages run: | # Use default CC to avoid compilation problems when installing Python modules. echo "Install neovim module for Python." diff --git a/MAINTAIN.md b/MAINTAIN.md @@ -25,7 +25,7 @@ The forecasting problem might be solved with an explicit priority system (like Bram's todo.txt). Meanwhile the Neovim priority system is defined by: * PRs nearing completion. -* Issue labels. E.g. the `+plan` label increases the ticket's priority merely +* Issue labels. E.g. the `has:plan` label increases the ticket's priority merely for having a plan written down: it is _closer to completion_ than tickets without a plan. * Comment activity or new information. @@ -89,7 +89,7 @@ These dependencies are "vendored" (inlined), we must update the sources manually * send improvements upstream! * `src/xdiff/`: [xdiff](https://github.com/git/git/tree/master/xdiff) * `src/cjson/`: [lua-cjson](https://github.com/openresty/lua-cjson) -* `src/nvim/lib/`: [Klib](https://github.com/attractivechaos/klib) +* `src/klib/`: [Klib](https://github.com/attractivechaos/klib) * `runtime/lua/vim/inspect.lua`: [inspect.lua](https://github.com/kikito/inspect.lua) * `src/nvim/tui/terminfo_defs.h`: terminfo definitions * Run `scripts/update_terminfo.sh` to update these definitions. diff --git a/cmake.packaging/CMakeLists.txt b/cmake.packaging/CMakeLists.txt @@ -40,8 +40,7 @@ if(WIN32) set(CPACK_PACKAGE_EXECUTABLES "nvim" "Neovim" "nvim-qt" "Neovim Qt") set(CPACK_CREATE_DESKTOP_LINKS "nvim-qt") - # We use a wix patch to add further options to the installer. At present, it just adds neovim to the path - # on installation and defines per-user installation, however, it can be extended. + # We use a wix patch to add further options to the installer. # See: https://cmake.org/cmake/help/v3.7/module/CPackWIX.html#variable:CPACK_WIX_PATCH_FILE list(APPEND CPACK_WIX_EXTENSIONS WixUtilExtension) list(APPEND CPACK_WIX_PATCH_FILE ${CMAKE_CURRENT_LIST_DIR}/WixPatch.xml) diff --git a/runtime/doc/api.txt b/runtime/doc/api.txt @@ -1795,6 +1795,7 @@ nvim_create_user_command({name}, {command}, {*opts}) • fargs: (table) The args split by unescaped whitespace (when more than one argument is allowed), if any |<f-args>| + • nargs: (string) Number of arguments |:command-nargs| • bang: (boolean) "true" if the command was executed with a ! modifier |<bang>| • line1: (number) The starting line of the command range diff --git a/runtime/doc/autocmd.txt b/runtime/doc/autocmd.txt @@ -1162,7 +1162,7 @@ Set the 'cindent' option for C files in the /vim/src directory. > If you have a link from "/tmp/test.c" to "/home/nobody/vim/src/test.c", and you start editing "/tmp/test.c", this autocommand will match. -Note: To match part of a path, but not from the root directory, use a '*' as +Note: To match part of a path, but not from the root directory, use a "*" as the first character. Example: > :autocmd BufRead */doc/*.txt set tw=78 This autocommand will for example be executed for "/tmp/doc/xx.txt" and diff --git a/runtime/doc/builtin.txt b/runtime/doc/builtin.txt @@ -6014,7 +6014,7 @@ printf({fmt}, {expr1} ...) *printf()* be applied, see below. A field width or precision, or both, may be indicated by an - asterisk '*' instead of a digit string. In this case, a + asterisk "*" instead of a digit string. In this case, a Number argument supplies the field width or precision. A negative field width is treated as a left adjustment flag followed by a positive field width; a negative precision is diff --git a/runtime/doc/cmdline.txt b/runtime/doc/cmdline.txt @@ -143,7 +143,7 @@ CTRL-R {register} *c_CTRL-R* *c_<C-R>* the last delete or yank '%' the current file name '#' the alternate file name - '*' the clipboard contents (X11: primary selection) + "*" the clipboard contents (X11: primary selection) '+' the clipboard contents '/' the last search pattern ':' the last command-line @@ -431,8 +431,8 @@ CTRL-T When 'incsearch' is set, entering a search pattern for "/" or keyboard T is above G. The 'wildchar' option defaults to <Tab> (CTRL-E when in Vi compatible mode; in -a previous version <Esc> was used). In the pattern standard wildcards '*' and -'?' are accepted when matching file names. '*' matches any string, '?' +a previous version <Esc> was used). In the pattern standard wildcards "*" and +'?' are accepted when matching file names. "*" matches any string, '?' matches exactly one character. When repeating 'wildchar' or CTRL-N you cycle through the matches, eventually diff --git a/runtime/doc/editing.txt b/runtime/doc/editing.txt @@ -1581,7 +1581,7 @@ There are three different types of searching: so they work on all operating systems. Note that "**" only acts as a special wildcard when it is at the start of a name. - The usage of '*' is quite simple: It matches 0 or more characters. In a + The usage of "*" is quite simple: It matches 0 or more characters. In a search pattern this would be ".*". Note that the "." is not used for file searching. diff --git a/runtime/doc/eval.txt b/runtime/doc/eval.txt @@ -1087,7 +1087,7 @@ That works, since the String "190" is automatically converted to the Number 1 . 90 * 90.0 Should be read as: > 1 . (90 * 90.0) -Since '.' has lower precedence than '*'. This does NOT work, since this +Since '.' has lower precedence than "*". This does NOT work, since this attempts to concatenate a Float and a String. When dividing a Number by zero the result depends on the value: @@ -2210,7 +2210,7 @@ v:register The name of the register in effect for the current normal mode (use this in custom commands that take a register). If none is supplied it is the default register '"', unless 'clipboard' contains "unnamed" or "unnamedplus", then it is - '*' or '+'. + "*" or '+'. Also see |getreg()| and |setreg()| *v:relnum* *relnum-variable* diff --git a/runtime/doc/ft_raku.txt b/runtime/doc/ft_raku.txt @@ -35,7 +35,7 @@ Some of them are available with standard Vim digraphs: (- ∈ ?= ≅ != ≠ ~ -) ∋ ?- ≃ ~ -The Greek alphabet is available with '*' followed by a similar Latin symbol: +The Greek alphabet is available with "*" followed by a similar Latin symbol: *p π ~ *t τ ~ *X × ~ diff --git a/runtime/doc/helphelp.txt b/runtime/doc/helphelp.txt @@ -167,7 +167,7 @@ The initial height of the help window can be set with the 'helpheight' option *help-buffer-options* When the help buffer is created, several local options are set to make sure the help text is displayed as it was intended: - 'iskeyword' nearly all ASCII chars except ' ', '*', '"' and '|' + 'iskeyword' nearly all ASCII chars except ' ', "*", '"' and '|' 'foldmethod' "manual" 'tabstop' 8 'arabic' off diff --git a/runtime/doc/indent.txt b/runtime/doc/indent.txt @@ -112,7 +112,7 @@ e Reindent a line that starts with "else" when you type the second 'e'. =~word Like =word, but ignore case. If you really want to reindent when you type 'o', 'O', 'e', '0', '<', '>', -'*', ':' or '!', use "<o>", "<O>", "<e>", "<0>", "<<>", "<>>", "<*>", "<:>" or +"*", ':' or '!', use "<o>", "<O>", "<e>", "<0>", "<<>", "<>>", "<*>", "<:>" or "<!>", respectively, for those keys. For an emacs-style indent mode where lines aren't indented every time you diff --git a/runtime/doc/insert.txt b/runtime/doc/insert.txt @@ -114,7 +114,7 @@ CTRL-R {register} *i_CTRL-R* the last delete or yank '%' the current file name '#' the alternate file name - '*' the clipboard contents (X11: primary selection) + "*" the clipboard contents (X11: primary selection) '+' the clipboard contents '/' the last search pattern ':' the last command-line @@ -1392,7 +1392,7 @@ other versions of HTML. Features: - after "<" complete tag name depending on context (no div suggestion inside of an a tag); '/>' indicates empty tags - inside of tag complete proper attributes (no width attribute for an a tag); - show also type of attribute; '*' indicates required attributes + show also type of attribute; "*" indicates required attributes - when attribute has limited number of possible values help to complete them - complete names of entities - complete values of "class" and "id" attributes with data obtained from diff --git a/runtime/doc/intro.txt b/runtime/doc/intro.txt @@ -385,7 +385,7 @@ Note: combinations actually work depends on the UI or host terminal. - When a key is pressed using a meta or alt modifier and no mapping exists for that keypress, Nvim may behave as though <Esc> was pressed before the key. -- It is possible to notate combined modifiers (e.g. <C-A-T> for CTRL-ALT-T), +- It is possible to notate combined modifiers (e.g. <M-C-T> for CTRL-ALT-T), but your terminal must encode the input for that to work. |tui-input| *<>* diff --git a/runtime/doc/job_control.txt b/runtime/doc/job_control.txt @@ -134,9 +134,6 @@ To send data to the job's stdin, use |chansend()|: >vim :call chansend(job1, "invalid-command\n") :call chansend(job1, "exit\n") < -A job may be killed with |jobstop()|: >vim - :call jobstop(job1) -< A job may be killed at any time with the |jobstop()| function: >vim :call jobstop(job1) diff --git a/runtime/doc/lsp.txt b/runtime/doc/lsp.txt @@ -954,8 +954,8 @@ start_client({config}) *vim.lsp.start_client()* • cmd_cwd: (string, default=|getcwd()|) Directory to launch the `cmd` process. Not related to `root_dir`. • cmd_env: (table) Environment flags to pass to the LSP on - spawn. Must be specified using a map-like table. - Non-string values are coerced to string. Example: > + spawn. Must be specified using a table. Non-string values + are coerced to string. Example: > { PORT = 8080; HOST = "0.0.0.0"; } < diff --git a/runtime/doc/lua-guide.txt b/runtime/doc/lua-guide.txt @@ -624,9 +624,9 @@ in a different file: >lua local mygroup = vim.api.nvim_create_augroup('vimrc', { clear = false }) vim.api.nvim_create_autocmd({ 'BufNewFile', 'BufRead' }, { - pattern = '*.html', + pattern = '*.c', group = mygroup, - command = 'set shiftwidth=4', + command = 'set noexpandtab', }) < ------------------------------------------------------------------------------ diff --git a/runtime/doc/lua.txt b/runtime/doc/lua.txt @@ -321,20 +321,22 @@ Example: >vim :echo luaeval('string.match(_A, "[a-z]+")', 'XYXfoo123') " foo < + *lua-table* Lua tables are used as both dictionaries and lists, so it is impossible to determine whether empty table is meant to be empty list or empty dictionary. Additionally Lua does not have integer numbers. To distinguish between these cases there is the following agreement: - + *lua-list* 0. Empty table is empty list. 1. Table with N incrementally growing integral numbers, starting from 1 and ending with N is considered to be a list. + *lua-dict* 2. Table with string keys, none of which contains NUL byte, is considered to be a dictionary. 3. Table with string keys, at least one of which contains NUL byte, is also considered to be a dictionary, but this time it is converted to a |msgpack-special-map|. - *lua-special-tbl* + *lua-special-tbl* 4. Table with `vim.type_idx` key may be a dictionary, a list or floating-point value: - `{[vim.type_idx]=vim.types.float, [vim.val_idx]=1}` is converted to @@ -1432,7 +1434,7 @@ keycode({str}) *vim.keycode()* • |nvim_replace_termcodes()| lua_omnifunc({find_start}, {_}) *vim.lua_omnifunc()* - Omnifunc for completing lua values from from the runtime lua interpreter, + Omnifunc for completing lua values from the runtime lua interpreter, similar to the builtin completion for the `:lua` command. Activate using `set omnifunc=v:lua.vim.lua_omnifunc` in a lua buffer. @@ -1881,7 +1883,7 @@ tbl_count({t}) *vim.tbl_count()* • https://github.com/Tieske/Penlight/blob/master/lua/pl/tablex.lua tbl_deep_extend({behavior}, {...}) *vim.tbl_deep_extend()* - Merges recursively two or more map-like tables. + Merges recursively two or more tables. Parameters: ~ • {behavior} (string) Decides what to do if a key is found in more than @@ -1889,7 +1891,7 @@ tbl_deep_extend({behavior}, {...}) *vim.tbl_deep_extend()* • "error": raise an error • "keep": use value from the leftmost map • "force": use value from the rightmost map - • {...} (table) Two or more map-like tables + • {...} (table) Two or more tables Return: ~ (table) Merged table @@ -1898,7 +1900,7 @@ tbl_deep_extend({behavior}, {...}) *vim.tbl_deep_extend()* • |vim.tbl_extend()| tbl_extend({behavior}, {...}) *vim.tbl_extend()* - Merges two or more map-like tables. + Merges two or more tables. Parameters: ~ • {behavior} (string) Decides what to do if a key is found in more than @@ -1906,7 +1908,7 @@ tbl_extend({behavior}, {...}) *vim.tbl_extend()* • "error": raise an error • "keep": use value from the leftmost map • "force": use value from the rightmost map - • {...} (table) Two or more map-like tables + • {...} (table) Two or more tables Return: ~ (table) Merged table @@ -2728,7 +2730,7 @@ versions (1.2.3-rc1) are not matched. > < cmp({v1}, {v2}) *vim.version.cmp()* - Parses and compares two version version objects (the result of + Parses and compares two version objects (the result of |vim.version.parse()|, or specified literally as a `{major, minor, patch}` tuple, e.g. `{1, 0, 3}`). diff --git a/runtime/doc/luvref.txt b/runtime/doc/luvref.txt @@ -2917,7 +2917,7 @@ uv.fs_fstat({fd} [, {callback}]) *uv.fs_fstat()* uv.fs_lstat({path} [, {callback}]) *uv.fs_lstat()* Parameters: - - `fd`: `integer` + - `path`: `string` - `callback`: `callable` (async version) or `nil` (sync version) - `err`: `nil` or `string` diff --git a/runtime/doc/news.txt b/runtime/doc/news.txt @@ -37,7 +37,7 @@ ADDED FEATURES *news-added* The following new APIs or features were added. • |vim.iter()| provides a generic iterator interface for tables and Lua -iterators |luaref-in|. + iterators |luaref-in|. • Added |vim.keycode()| for translating keycodes in a string. @@ -51,7 +51,7 @@ iterators |luaref-in|. default). • |'smoothscroll'| option to scroll by screen line rather than by text line -when |'wrap'| is set. + when |'wrap'| is set. • |Query:iter_matches()| now has the ability to set the maximum start depth for matches. @@ -88,10 +88,10 @@ The following functions are now deprecated and will be removed in the next release. • Checkhealth functions: - - |health#report_error|, |vim.health.report_error()| Use Lua |vim.health.error()| instead. - - |health#report_info|, |vim.health.report_info()| Use Lua |vim.health.info()| instead. - - |health#report_ok|, |vim.health.report_ok()| Use Lua |vim.health.ok()| instead. - - |health#report_start|, |vim.health.report_start()| Use Lua |vim.health.start()| instead. - - |health#report_warn|, |vim.health.report_warn()| Use Lua |vim.health.warn()| instead. + - |health#report_error|, |vim.health.report_error()| Use |vim.health.error()| instead. + - |health#report_info|, |vim.health.report_info()| Use |vim.health.info()| instead. + - |health#report_ok|, |vim.health.report_ok()| Use |vim.health.ok()| instead. + - |health#report_start|, |vim.health.report_start()| Use |vim.health.start()| instead. + - |health#report_warn|, |vim.health.report_warn()| Use |vim.health.warn()| instead. vim:tw=78:ts=8:sw=2:et:ft=help:norl: diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt @@ -1324,7 +1324,7 @@ A jump table for the options with a short description can be found at |Q_op|. register. When "unnamed" is also included to the option, yank and delete operations (but not put) will additionally copy the text into register - '*'. See |clipboard|. + "*". See |clipboard|. *'cmdheight'* *'ch'* 'cmdheight' 'ch' number (default 1) @@ -3523,7 +3523,7 @@ A jump table for the options with a short description can be found at |Q_op|. that is not white space or punctuation). For C programs you could use "a-z,A-Z,48-57,_,.,-,>". For a help file it is set to all non-blank printable characters except - '*', '"' and '|' (so that CTRL-] on a command finds the help for that + "*", '"' and '|' (so that CTRL-] on a command finds the help for that command). When the 'lisp' option is on the '-' character is always included. This option also influences syntax highlighting, unless the syntax diff --git a/runtime/doc/pi_netrw.txt b/runtime/doc/pi_netrw.txt @@ -4125,7 +4125,7 @@ netrw: The "<nowait>" modifier has been included with most of netrw's mappings to avoid that delay. - Jun 26, 2015 * |netrw-gn| mapping implemted + Jun 26, 2015 * |netrw-gn| mapping implemented * :Ntree NotADir resulted in having the tree listing expand in the error messages window. Fixed. @@ -4332,8 +4332,8 @@ netrw: Dec 24, 2013 * (esquifit) asked that netrw allow the /cygdrive prefix be a user-alterable parameter. - Jan 02, 2014 * Fixed a problem with netrw-based ballon - evaluation (ie. netrw#NetrwBaloonHelp() + Jan 02, 2014 * Fixed a problem with netrw-based balloon + evaluation (ie. netrw#NetrwBalloonHelp() not having been loaded error messages) Jan 03, 2014 * Fixed a problem with tree listings * New command installed: |:Ntree| diff --git a/runtime/doc/pi_tar.txt b/runtime/doc/pi_tar.txt @@ -44,8 +44,8 @@ Copyright 2005-2017: *tar-copyright* the file mentioned in the tarball. If the current directory is not correct for that path, :TarDiff will fail to find the associated file. - If the [filename] is given, that that filename (and path) will be used - to specify the associated file. + If the [filename] is given, that filename (and path) will be used to + specify the associated file. PREVENTING LOADING~ diff --git a/runtime/doc/provider.txt b/runtime/doc/provider.txt @@ -182,7 +182,7 @@ the "+" and/or "*" registers explicitly): >vim See 'clipboard' for details and options. *clipboard-tool* -The presence of a working clipboard tool implicitly enables the '+' and '*' +The presence of a working clipboard tool implicitly enables the '+' and "*" registers. Nvim looks for these clipboard tools, in order of priority: - |g:clipboard| diff --git a/runtime/doc/quickfix.txt b/runtime/doc/quickfix.txt @@ -1615,7 +1615,7 @@ be escaped), meta symbols have to be written with leading '%': %\ The single '\' character. Note that this has to be escaped ("%\\") in ":set errorformat=" definitions. %. The single '.' character. - %# The single '*'(!) character. + %# The single "*"(!) character. %^ The single '^' character. Note that this is not useful, the pattern already matches start of line. %$ The single '$' character. Note that this is not diff --git a/runtime/doc/sign.txt b/runtime/doc/sign.txt @@ -468,7 +468,7 @@ sign_getplaced([{buf} [, {dict}]]) *sign_getplaced()* id select sign with this identifier lnum select signs placed in this line. For the use of {lnum}, see |line()|. - If {group} is '*', then signs in all the groups including the + If {group} is "*", then signs in all the groups including the global group are returned. If {group} is not supplied or is an empty string, then only signs in the global group are returned. If no arguments are supplied, then signs in the @@ -683,7 +683,7 @@ sign_unplace({group} [, {dict}]) *sign_unplace()* is similar to the |:sign-unplace| command. {group} is the sign group name. To use the global sign group, - use an empty string. If {group} is set to '*', then all the + use an empty string. If {group} is set to "*", then all the groups including the global group are used. The signs in {group} are selected based on the entries in {dict}. The following optional entries in {dict} are @@ -735,7 +735,7 @@ sign_unplacelist({list}) *sign_unplacelist()* the buffers. group sign group name. If not specified or set to an empty string, then the global sign group is - used. If set to '*', then all the groups + used. If set to "*", then all the groups including the global group are used. id sign identifier. If not specified, then all the signs in the specified group are removed. diff --git a/runtime/doc/spell.txt b/runtime/doc/spell.txt @@ -409,7 +409,7 @@ of the previous line "al." will be flagged as an error. And when you type Use |CTRL-L| to redraw right away. "[s" will also stop at a word combination with a line break. -When encountering a line break Vim skips characters such as '*', '>' and '"', +When encountering a line break Vim skips characters such as "*", '>' and '"', so that comments in C, shell and Vim code can be spell checked. diff --git a/runtime/doc/syntax.txt b/runtime/doc/syntax.txt @@ -5020,7 +5020,7 @@ stop={term-list} *term-list* *highlight-stop* highlighted area. This should undo the "start" argument. Otherwise the screen will look messed up. - {term-list} is a a string with escape sequences. This is any string of + {term-list} is a string with escape sequences. This is any string of characters, except that it can't start with "t_" and blanks are not allowed. The <> notation is recognized here, so you can use things like "<Esc>" and "<Space>". Example: @@ -5058,10 +5058,10 @@ ctermbg={color-nr} *ctermbg* The number under "NR-16" is used for 16-color terminals ('t_Co' greater than or equal to 16). The number under "NR-8" is used for - 8-color terminals ('t_Co' less than 16). The '*' indicates that the + 8-color terminals ('t_Co' less than 16). The "*" indicates that the bold attribute is set for ctermfg. In many 8-color terminals (e.g., "linux"), this causes the bright colors to appear. This doesn't work - for background colors! Without the '*' the bold attribute is removed. + for background colors! Without the "*" the bold attribute is removed. If you want to set the bold attribute in a different way, put a "cterm=" argument AFTER the "ctermfg=" or "ctermbg=" argument. Or use a number instead of a color name. diff --git a/runtime/doc/treesitter.txt b/runtime/doc/treesitter.txt @@ -18,12 +18,13 @@ changes. This documentation may also not fully reflect the latest changes. PARSER FILES *treesitter-parsers* Parsers are the heart of tree-sitter. They are libraries that tree-sitter will -search for in the `parser` runtime directory. By default, Nvim bundles only -parsers for C, Lua, and Vimscript, but parsers can be installed manually or -via a plugin like https://github.com/nvim-treesitter/nvim-treesitter. -Parsers are searched for as `parser/{lang}.*` in any 'runtimepath' directory. -If multiple parsers for the same language are found, the first one is used. -(This typically implies the priority "user config > plugins > bundled". +search for in the `parser` runtime directory. By default, Nvim bundles parsers +for C, Lua, Vimscript, Vimdoc and Treesitter query files, but parsers can be +installed manually or via a plugin like +https://github.com/nvim-treesitter/nvim-treesitter. Parsers are searched for +as `parser/{lang}.*` in any 'runtimepath' directory. If multiple parsers for +the same language are found, the first one is used. (This typically implies +the priority "user config > plugins > bundled". A parser can also be loaded manually using a full path: >lua vim.treesitter.language.add('python', { path = "/path/to/python.so" }) @@ -307,10 +308,10 @@ currently supported modeline alternatives: Note: These modeline comments must be at the top of the query, but can be repeated, for example, the following two modeline blocks are both valid: >query - ;; inherits: foo,bar ;; extends - +< +>query ;; extends ;; ;; inherits: baz @@ -907,11 +908,10 @@ Query:iter_captures({self}, {node}, {source}, {start}, {stop}) {source} is needed if the query contains predicates; then the caller must ensure to use a freshly parsed tree consistent with the current text of - the buffer (if relevant). {start_row} and {end_row} can be used to limit - matches inside a row range (this is typically used with root node as the - {node}, i.e., to get syntax highlight matches in the current viewport). - When omitted, the {start} and {end} row values are used from the given - node. + the buffer (if relevant). {start} and {stop} can be used to limit matches + inside a row range (this is typically used with root node as the {node}, + i.e., to get syntax highlight matches in the current viewport). When + omitted, the {start} and {stop} row values are used from the given node. The iterator returns three values: a numeric id identifying the capture, the captured node, and metadata from any directives processing the match. @@ -1164,12 +1164,15 @@ LanguageTree:register_cbs({self}, {cbs}, {recursive}) • `on_bytes` : see |nvim_buf_attach()|, but this will be called after the parsers callback. • `on_changedtree` : a callback that will be called every time the tree has syntactical changes. It will - only be passed one argument, which is a table of the - ranges (as node ranges) that changed. + be passed two arguments: a table of the ranges (as + node ranges) that changed and the changed tree. • `on_child_added` : emitted when a child is added to the tree. • `on_child_removed` : emitted when a child is removed from the tree. + • `on_detach` : emitted when the buffer is detached, see + |nvim_buf_detach_event|. Takes one argument, the + number of the buffer. • {recursive?} boolean Apply callbacks recursively for all children. Any new children will also inherit the callbacks. • {self} diff --git a/runtime/doc/ui.txt b/runtime/doc/ui.txt @@ -336,7 +336,7 @@ numerical highlight ids to the actual attributes. Highlights are always transmitted both for both the RGB format and as terminal 256-color codes, as the `rgb_attr` and `cterm_attr` parameters - respectively. The |ui-rgb| option has no effect effect anymore. + respectively. The |ui-rgb| option has no effect anymore. Most external UIs will only need to store and use the `rgb_attr` attributes. @@ -352,7 +352,7 @@ numerical highlight ids to the actual attributes. |ui-hlstate| extension explained below. ["hl_group_set", name, hl_id] ~ - The bulitin highlight group `name` was set to use the attributes `hl_id` + The built-in highlight group `name` was set to use the attributes `hl_id` defined by a previous `hl_attr_define` call. This event is not needed to render the grids which use attribute ids directly, but is useful for a UI who want to render its own elements with consistent @@ -710,7 +710,7 @@ For command-line 'wildmenu' UI events, activate |ui-popupmenu|. to distinguish different command lines active at the same time. The first invoked command line has level 1, the next recursively-invoked prompt has level 2. A command line invoked from the |cmdline-window| - has a higher level than than the edited command line. + has a higher level than the edited command line. ["cmdline_pos", pos, level] ~ Change the cursor position in the cmdline. diff --git a/runtime/doc/visual.txt b/runtime/doc/visual.txt @@ -398,7 +398,7 @@ selected text: > (In the <> notation |<>|, when typing it you should type it literally; you need to remove the 'B' flag from 'cpoptions') -Note that special characters (like '.' and '*') will cause problems. +Note that special characters (like '.' and "*") will cause problems. Visual-block Examples *blockwise-examples* With the following text, I will indicate the commands to produce the block and diff --git a/runtime/lua/_vim9script.lua b/runtime/lua/_vim9script.lua @@ -312,7 +312,7 @@ vim9['fn'] = (function() -- We do have vim9script ;) that's this plugin ['vim9script'] = true, - -- Include some vim patches that are sometimes required by variuos vim9script plugins + -- Include some vim patches that are sometimes required by various vim9script plugins -- that we implement via vim9jit [ [[patch-8.2.2261]] ] = true, [ [[patch-8.2.4257]] ] = true, diff --git a/runtime/lua/vim/_editor.lua b/runtime/lua/vim/_editor.lua @@ -778,7 +778,7 @@ do -- some bugs, so fake the two-step dance for now. local matches - --- Omnifunc for completing lua values from from the runtime lua interpreter, + --- Omnifunc for completing lua values from the runtime lua interpreter, --- similar to the builtin completion for the `:lua` command. --- --- Activate using `set omnifunc=v:lua.vim.lua_omnifunc` in a lua buffer. diff --git a/runtime/lua/vim/_inspector.lua b/runtime/lua/vim/_inspector.lua @@ -90,7 +90,7 @@ function vim.inspect_pos(bufnr, row, col, filter) nsmap[id] = name end - --- Convert an extmark tuple into a map-like table + --- Convert an extmark tuple into a table --- @private local function to_map(extmark) extmark = { diff --git a/runtime/lua/vim/lsp.lua b/runtime/lua/vim/lsp.lua @@ -913,7 +913,7 @@ end --- the `cmd` process. Not related to `root_dir`. --- --- - cmd_env: (table) Environment flags to pass to the LSP on ---- spawn. Must be specified using a map-like table. +--- spawn. Must be specified using a table. --- Non-string values are coerced to string. --- Example: --- <pre> diff --git a/runtime/lua/vim/shared.lua b/runtime/lua/vim/shared.lua @@ -361,7 +361,7 @@ local function tbl_extend(behavior, deep_extend, ...) return ret end ---- Merges two or more map-like tables. +--- Merges two or more tables. --- ---@see |extend()| --- @@ -369,13 +369,13 @@ end --- - "error": raise an error --- - "keep": use value from the leftmost map --- - "force": use value from the rightmost map ----@param ... table Two or more map-like tables +---@param ... table Two or more tables ---@return table Merged table function vim.tbl_extend(behavior, ...) return tbl_extend(behavior, false, ...) end ---- Merges recursively two or more map-like tables. +--- Merges recursively two or more tables. --- ---@see |vim.tbl_extend()| --- @@ -385,7 +385,7 @@ end --- - "error": raise an error --- - "keep": use value from the leftmost map --- - "force": use value from the rightmost map ----@param ... T2 Two or more map-like tables +---@param ... T2 Two or more tables ---@return T1|T2 (table) Merged table function vim.tbl_deep_extend(behavior, ...) return tbl_extend(behavior, true, ...) diff --git a/runtime/lua/vim/treesitter/languagetree.lua b/runtime/lua/vim/treesitter/languagetree.lua @@ -882,10 +882,12 @@ end ---@param cbs table An |nvim_buf_attach()|-like table argument with the following handlers: --- - `on_bytes` : see |nvim_buf_attach()|, but this will be called _after_ the parsers callback. --- - `on_changedtree` : a callback that will be called every time the tree has syntactical changes. ---- It will only be passed one argument, which is a table of the ranges (as node ranges) that ---- changed. +--- It will be passed two arguments: a table of the ranges (as node ranges) that +--- changed and the changed tree. --- - `on_child_added` : emitted when a child is added to the tree. --- - `on_child_removed` : emitted when a child is removed from the tree. +--- - `on_detach` : emitted when the buffer is detached, see |nvim_buf_detach_event|. +--- Takes one argument, the number of the buffer. --- @param recursive? boolean Apply callbacks recursively for all children. Any new children will --- also inherit the callbacks. function LanguageTree:register_cbs(cbs, recursive) diff --git a/runtime/lua/vim/treesitter/query.lua b/runtime/lua/vim/treesitter/query.lua @@ -609,10 +609,10 @@ end --- --- {source} is needed if the query contains predicates; then the caller --- must ensure to use a freshly parsed tree consistent with the current ---- text of the buffer (if relevant). {start_row} and {end_row} can be used to limit +--- text of the buffer (if relevant). {start} and {stop} can be used to limit --- matches inside a row range (this is typically used with root node --- as the {node}, i.e., to get syntax highlight matches in the current ---- viewport). When omitted, the {start} and {end} row values are used from the given node. +--- viewport). When omitted, the {start} and {stop} row values are used from the given node. --- --- The iterator returns three values: a numeric id identifying the capture, --- the captured node, and metadata from any directives processing the match. diff --git a/runtime/lua/vim/version.lua b/runtime/lua/vim/version.lua @@ -333,7 +333,7 @@ local function create_err_msg(v) return string.format('invalid version: %s (%s)', tostring(v), type(v)) end ---- Parses and compares two version version objects (the result of |vim.version.parse()|, or +--- Parses and compares two version objects (the result of |vim.version.parse()|, or --- specified literally as a `{major, minor, patch}` tuple, e.g. `{1, 0, 3}`). --- --- Example: diff --git a/src/nvim/api/command.c b/src/nvim/api/command.c @@ -916,6 +916,7 @@ static void build_cmdline_str(char **cmdlinep, exarg_T *eap, CmdParseInfo *cmdin /// - args: (string) The args passed to the command, if any |<args>| /// - fargs: (table) The args split by unescaped whitespace (when more than one /// argument is allowed), if any |<f-args>| +/// - nargs: (string) Number of arguments |:command-nargs| /// - bang: (boolean) "true" if the command was executed with a ! modifier |<bang>| /// - line1: (number) The starting line of the command range |<line1>| /// - line2: (number) The final line of the command range |<line2>| diff --git a/src/nvim/main.c b/src/nvim/main.c @@ -443,8 +443,7 @@ int main(int argc, char **argv) // If using the runtime (-u is not NONE), enable syntax & filetype plugins. if (!vimrc_none || params.clean) { - // Sources filetype.lua and filetype.vim unless the user explicitly disabled it with :filetype - // off. + // Sources filetype.lua unless the user explicitly disabled it with :filetype off. filetype_maybe_enable(); // Sources syntax/syntax.vim. We do this *after* the user startup scripts so that users can // disable syntax highlighting with `:syntax off` if they wish. diff --git a/src/nvim/os/time.c b/src/nvim/os/time.c @@ -74,7 +74,7 @@ void os_delay(uint64_t ms, bool ignoreinput) /// /// This blocks even "fast" events which is quite disruptive. This should only /// be used in debug code. Prefer os_delay() and decide if the delay should be -/// interupted by input or only a CTRL-C. +/// interrupted by input or only a CTRL-C. /// /// @see uv_sleep() (libuv v1.34.0) /// diff --git a/src/nvim/viml/parser/expressions.c b/src/nvim/viml/parser/expressions.c @@ -2866,7 +2866,7 @@ viml_pexpr_parse_no_paren_closing_error: {} case kENodeOperator: if (prev_token.type == kExprLexSpacing) { // For some reason "function (args)" is a function call, but - // "(funcref) (args)" is not. AFAIR this somehow involves + // "(funcref) (args)" is not. As far as I remember this somehow involves // compatibility and Bram was commenting that this is // intentionally inconsistent and he is not very happy with the // situation himself.