]> git.ipfire.org Git - thirdparty/vim.git/commitdiff
runtime(doc): minor updates.
authorShane Harper <shane@shaneharper.net>
Wed, 17 Jul 2024 17:40:40 +0000 (19:40 +0200)
committerChristian Brabandt <cb@256bit.org>
Wed, 17 Jul 2024 18:04:22 +0000 (20:04 +0200)
closes: #15280

Signed-off-by: Shane Harper <shane@shaneharper.net>
Signed-off-by: Christian Brabandt <cb@256bit.org>
runtime/doc/builtin.txt
runtime/doc/channel.txt
runtime/doc/eval.txt
runtime/doc/gui.txt
runtime/doc/quickfix.txt
runtime/doc/testing.txt
runtime/doc/various.txt

index 6b77d44f940215962ca5bcd9b21fd33601881fbb..c4e7d36a46b601de4b147b2f269d371d7140b469 100644 (file)
@@ -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} [, {id} [, {dict}]]])
 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}]])            *spellsuggest()*
 
 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|
index f2946795514d8119c79a3427461aaf445594e834..c1fae514667b89de5aa65edc104f5974a14dfcc0 100644 (file)
@@ -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}])                  *job_start()*
                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
index eddafd078e0debe239519562e094d1045b822bf3..b921cb54a973980bcab0ecc803ea38fb7da8294b 100644 (file)
@@ -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
index 3b559196b8b44b609f3d5ea2dfcc56fcd53a1f24..071de9c4b133c88ca7916d2d256ddae0337a75ca 100644 (file)
@@ -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 are affected.
 
 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.<C-R>z <C-R>z<CR>
index ed9997807df6f5bb469a8cdd9e3747939c24c3f1..d759c18a4abce49c473bc8936d5b1cd8a7cda29c 100644 (file)
@@ -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 @@ commands can be combined to create a NewGrep command: >
 
 :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
 <
index ebf562bef4836ae1fd7d65d12ad18b015f8da19f..47ae85afb00119e16ca46cd25c4b3223884d03d1 100644 (file)
@@ -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} [, {msg}])
                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}])                    *assert_false()*
                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}])                             *assert_true()*
                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()
index 1ce892733ac926675e68fdca706e6d866e4b7a27..acd79914db1ab8207e29d522005018ba6cf82ae5 100644 (file)
@@ -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.  The redraw may happen
                                                        *: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 !