# HG changeset patch # User Christian Brabandt # Date 1721240107 -7200 # Node ID f7f4f803a0bd26df879811d9bb0e7cabaa9d1a8c # Parent 9f2d488684ad27a1d6164f8376686ddf8feb403f runtime(doc): minor updates. Commit: https://github.com/vim/vim/commit/c1b3984a7b3cd6adcd1f43e558cb04fad1af3182 Author: Shane Harper Date: Wed Jul 17 19:40:40 2024 +0200 runtime(doc): minor updates. closes: https://github.com/vim/vim/issues/15280 Signed-off-by: Shane Harper Signed-off-by: Christian Brabandt diff --git a/runtime/doc/builtin.txt b/runtime/doc/builtin.txt --- a/runtime/doc/builtin.txt +++ b/runtime/doc/builtin.txt @@ -1,4 +1,4 @@ -*builtin.txt* For Vim version 9.1. Last change: 2024 Jul 16 +*builtin.txt* For Vim version 9.1. Last change: 2024 Jul 17 VIM REFERENCE MANUAL by Bram Moolenaar @@ -6947,10 +6947,10 @@ matchadd({group}, {pattern} [, {priority matchaddpos({group}, {pos} [, {priority} [, {id} [, {dict}]]]) Same as |matchadd()|, but requires a list of positions {pos} instead of a pattern. This command is faster than |matchadd()| - because it does not require to handle regular expressions and - sets buffer line boundaries to redraw screen. It is supposed - to be used when fast match additions and deletions are - required, for example to highlight matching parentheses. + because it does not handle regular expressions and it sets + buffer line boundaries to redraw screen. It is supposed to be + used when fast match additions and deletions are required, for + example to highlight matching parentheses. {pos} is a list of positions. Each position can be one of these: @@ -10334,8 +10334,8 @@ spellsuggest({word} [, {max} [, {capital split({string} [, {pattern} [, {keepempty}]]) *split()* Make a |List| out of {string}. When {pattern} is omitted or - empty each white-separated sequence of characters becomes an - item. + empty each white space separated sequence of characters + becomes an item. Otherwise the string is split where {pattern} matches, removing the matched characters. 'ignorecase' is not used here, add \c to ignore case. |/\c| diff --git a/runtime/doc/channel.txt b/runtime/doc/channel.txt --- a/runtime/doc/channel.txt +++ b/runtime/doc/channel.txt @@ -1,4 +1,4 @@ -*channel.txt* For Vim version 9.1. Last change: 2024 Jun 13 +*channel.txt* For Vim version 9.1. Last change: 2024 Jul 17 VIM REFERENCE MANUAL by Bram Moolenaar @@ -981,8 +981,9 @@ job_start({command} [, {options}]) *jo invoked. {command} can be a String. This works best on MS-Windows. On - Unix it is split up in white-separated parts to be passed to - execvp(). Arguments in double quotes can contain white space. + Unix it is split up in white space separated parts to be + passed to execvp(). Arguments in double quotes can contain + white space. {command} can be a List, where the first item is the executable and further items are the arguments. All items are converted diff --git a/runtime/doc/eval.txt b/runtime/doc/eval.txt --- a/runtime/doc/eval.txt +++ b/runtime/doc/eval.txt @@ -1,4 +1,4 @@ -*eval.txt* For Vim version 9.1. Last change: 2024 Jun 01 +*eval.txt* For Vim version 9.1. Last change: 2024 Jul 17 VIM REFERENCE MANUAL by Bram Moolenaar @@ -3124,9 +3124,10 @@ text... let lconst[0] = 2 " Error! let lconst[1][0] = 'b' " OK < *E995* - |:const| does not allow to for changing a variable: > + It is an error to specify an existing variable with + :const. > :let x = 1 - :const x = 2 " Error! + :const x = 1 " Error! < *E996* Note that environment variables, option values and register values cannot be used here, since they cannot diff --git a/runtime/doc/gui.txt b/runtime/doc/gui.txt --- a/runtime/doc/gui.txt +++ b/runtime/doc/gui.txt @@ -1,4 +1,4 @@ -*gui.txt* For Vim version 9.1. Last change: 2024 May 11 +*gui.txt* For Vim version 9.1. Last change: 2024 Jul 17 VIM REFERENCE MANUAL by Bram Moolenaar @@ -970,7 +970,7 @@ name and all existing submenus below it 5.7 Examples for Menus *menu-examples* -Here is an example on how to add menu items with menu's! You can add a menu +Here is an example on how to add menu items with menus. You can add a menu item for the keyword under the cursor. The register "z" is used. > :nmenu Words.Add\ Var wb"zye:menu! Words.z z diff --git a/runtime/doc/quickfix.txt b/runtime/doc/quickfix.txt --- a/runtime/doc/quickfix.txt +++ b/runtime/doc/quickfix.txt @@ -1,4 +1,4 @@ -*quickfix.txt* For Vim version 9.1. Last change: 2024 Jul 15 +*quickfix.txt* For Vim version 9.1. Last change: 2024 Jul 17 VIM REFERENCE MANUAL by Bram Moolenaar @@ -1092,8 +1092,8 @@ 5.1 using Vim's internal grep :vim[grep][!] {pattern} {file} ... Like above, but instead of enclosing the pattern in a - non-ID character use a white-separated pattern. The - pattern must start with an ID character. + non-ID character use a white space separated pattern. + The pattern must start with an ID character. Example: > :vimgrep Error *.c < diff --git a/runtime/doc/testing.txt b/runtime/doc/testing.txt --- a/runtime/doc/testing.txt +++ b/runtime/doc/testing.txt @@ -1,4 +1,4 @@ -*testing.txt* For Vim version 9.1. Last change: 2024 Jun 17 +*testing.txt* For Vim version 9.1. Last change: 2024 Jul 17 VIM REFERENCE MANUAL by Bram Moolenaar @@ -506,16 +506,17 @@ assert_equal({expected}, {actual} [, {ms added to |v:errors| and 1 is returned. Otherwise zero is returned. |assert-return| The error is in the form "Expected {expected} but got - {actual}". When {msg} is present it is prefixed to that. + {actual}". When {msg} is present it is prefixed to that, along + with the location of the assert when run from a script. There is no automatic conversion, the String "4" is different from the Number 4. And the number 4 is different from the Float 4.0. The value of 'ignorecase' is not used here, case always matters. Example: > - assert_equal('foo', 'bar') -< Will result in a string to be added to |v:errors|: - test.vim line 12: Expected 'foo' but got 'bar' ~ + call assert_equal('foo', 'bar', 'baz') +< Will add the following to |v:errors|: + test.vim line 12: baz: Expected 'foo' but got 'bar' ~ Can also be used as a |method|, the base is passed as the second argument: > @@ -599,7 +600,8 @@ assert_false({actual} [, {msg}]) *asse When {actual} is not false an error message is added to |v:errors|, like with |assert_equal()|. The error is in the form "Expected False but got {actual}". - When {msg} is present it is prepended to that. + When {msg} is present it is prepended to that, along + with the location of the assert when run from a script. Also see |assert-return|. A value is false when it is zero. When {actual} is not a @@ -625,7 +627,8 @@ assert_match({pattern}, {actual} [, {msg When {pattern} does not match {actual} an error message is added to |v:errors|. Also see |assert-return|. The error is in the form "Pattern {pattern} does not match - {actual}". When {msg} is present it is prefixed to that. + {actual}". When {msg} is present it is prefixed to that, + along with the location of the assert when run from a script. {pattern} is used as with |=~|: The matching is always done like 'magic' was set and 'cpoptions' is empty, no matter what @@ -636,7 +639,7 @@ assert_match({pattern}, {actual} [, {msg Use both to match the whole text. Example: > - assert_match('^f.*o$', 'foobar') + assert_match('^f.*o$', 'foobar') < Will result in a string to be added to |v:errors|: test.vim line 12: Pattern '^f.*o$' does not match 'foobar' ~ @@ -693,7 +696,8 @@ assert_true({actual} [, {msg}]) *asse Also see |assert-return|. A value is TRUE when it is a non-zero number. When {actual} is not a number the assert fails. - When {msg} is given it precedes the default message. + When {msg} is given it precedes the default message, along + with the location of the assert when run from a script. Can also be used as a |method|: > GetResult()->assert_true() diff --git a/runtime/doc/various.txt b/runtime/doc/various.txt --- a/runtime/doc/various.txt +++ b/runtime/doc/various.txt @@ -1,4 +1,4 @@ -*various.txt* For Vim version 9.1. Last change: 2024 Jun 17 +*various.txt* For Vim version 9.1. Last change: 2024 Jul 17 VIM REFERENCE MANUAL by Bram Moolenaar @@ -19,9 +19,8 @@ CTRL-L Clear and redraw the screen. T *:redr* *:redraw* :redr[aw][!] Redraw the screen right now. When ! is included it is cleared first. - Useful to update the screen halfway executing a script - or function. Also when halfway a mapping and - 'lazyredraw' is set. + It can be used to redraw the screen in a script + or function (or a mapping if |'lazyredraw'| is set). *:redraws* *:redrawstatus* :redraws[tatus][!] Redraw the status line of the current window. When !