Skip to content

Commit c1b3984

Browse files
shaneharperchrisbra
authored andcommitted
runtime(doc): minor updates.
closes: #15280 Signed-off-by: Shane Harper <shane@shaneharper.net> Signed-off-by: Christian Brabandt <cb@256bit.org>
1 parent 080ba2c commit c1b3984

7 files changed

Lines changed: 36 additions & 31 deletions

File tree

runtime/doc/builtin.txt

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
*builtin.txt* For Vim version 9.1. Last change: 2024 Jul 16
1+
*builtin.txt* For Vim version 9.1. Last change: 2024 Jul 17
22

33

44
VIM REFERENCE MANUAL by Bram Moolenaar
@@ -6947,10 +6947,10 @@ matchadd({group}, {pattern} [, {priority} [, {id} [, {dict}]]])
69476947
matchaddpos({group}, {pos} [, {priority} [, {id} [, {dict}]]])
69486948
Same as |matchadd()|, but requires a list of positions {pos}
69496949
instead of a pattern. This command is faster than |matchadd()|
6950-
because it does not require to handle regular expressions and
6951-
sets buffer line boundaries to redraw screen. It is supposed
6952-
to be used when fast match additions and deletions are
6953-
required, for example to highlight matching parentheses.
6950+
because it does not handle regular expressions and it sets
6951+
buffer line boundaries to redraw screen. It is supposed to be
6952+
used when fast match additions and deletions are required, for
6953+
example to highlight matching parentheses.
69546954

69556955
{pos} is a list of positions. Each position can be one of
69566956
these:
@@ -10334,8 +10334,8 @@ spellsuggest({word} [, {max} [, {capital}]]) *spellsuggest()*
1033410334

1033510335
split({string} [, {pattern} [, {keepempty}]]) *split()*
1033610336
Make a |List| out of {string}. When {pattern} is omitted or
10337-
empty each white-separated sequence of characters becomes an
10338-
item.
10337+
empty each white space separated sequence of characters
10338+
becomes an item.
1033910339
Otherwise the string is split where {pattern} matches,
1034010340
removing the matched characters. 'ignorecase' is not used
1034110341
here, add \c to ignore case. |/\c|

runtime/doc/channel.txt

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
*channel.txt* For Vim version 9.1. Last change: 2024 Jun 13
1+
*channel.txt* For Vim version 9.1. Last change: 2024 Jul 17
22

33

44
VIM REFERENCE MANUAL by Bram Moolenaar
@@ -981,8 +981,9 @@ job_start({command} [, {options}]) *job_start()*
981981
invoked.
982982

983983
{command} can be a String. This works best on MS-Windows. On
984-
Unix it is split up in white-separated parts to be passed to
985-
execvp(). Arguments in double quotes can contain white space.
984+
Unix it is split up in white space separated parts to be
985+
passed to execvp(). Arguments in double quotes can contain
986+
white space.
986987

987988
{command} can be a List, where the first item is the executable
988989
and further items are the arguments. All items are converted

runtime/doc/eval.txt

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
*eval.txt* For Vim version 9.1. Last change: 2024 Jun 01
1+
*eval.txt* For Vim version 9.1. Last change: 2024 Jul 17
22

33

44
VIM REFERENCE MANUAL by Bram Moolenaar
@@ -3124,9 +3124,10 @@ text...
31243124
let lconst[0] = 2 " Error!
31253125
let lconst[1][0] = 'b' " OK
31263126
< *E995*
3127-
|:const| does not allow to for changing a variable: >
3127+
It is an error to specify an existing variable with
3128+
:const. >
31283129
:let x = 1
3129-
:const x = 2 " Error!
3130+
:const x = 1 " Error!
31303131
< *E996*
31313132
Note that environment variables, option values and
31323133
register values cannot be used here, since they cannot

runtime/doc/gui.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
*gui.txt* For Vim version 9.1. Last change: 2024 May 11
1+
*gui.txt* For Vim version 9.1. Last change: 2024 Jul 17
22

33

44
VIM REFERENCE MANUAL by Bram Moolenaar
@@ -970,7 +970,7 @@ name and all existing submenus below it are affected.
970970

971971
5.7 Examples for Menus *menu-examples*
972972

973-
Here is an example on how to add menu items with menu's! You can add a menu
973+
Here is an example on how to add menu items with menus. You can add a menu
974974
item for the keyword under the cursor. The register "z" is used. >
975975
976976
:nmenu Words.Add\ Var wb"zye:menu! Words.<C-R>z <C-R>z<CR>

runtime/doc/quickfix.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
*quickfix.txt* For Vim version 9.1. Last change: 2024 Jul 15
1+
*quickfix.txt* For Vim version 9.1. Last change: 2024 Jul 17
22

33

44
VIM REFERENCE MANUAL by Bram Moolenaar
@@ -1092,8 +1092,8 @@ commands can be combined to create a NewGrep command: >
10921092

10931093
:vim[grep][!] {pattern} {file} ...
10941094
Like above, but instead of enclosing the pattern in a
1095-
non-ID character use a white-separated pattern. The
1096-
pattern must start with an ID character.
1095+
non-ID character use a white space separated pattern.
1096+
The pattern must start with an ID character.
10971097
Example: >
10981098
:vimgrep Error *.c
10991099
<

runtime/doc/testing.txt

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
*testing.txt* For Vim version 9.1. Last change: 2024 Jun 17
1+
*testing.txt* For Vim version 9.1. Last change: 2024 Jul 17
22

33

44
VIM REFERENCE MANUAL by Bram Moolenaar
@@ -506,16 +506,17 @@ assert_equal({expected}, {actual} [, {msg}])
506506
added to |v:errors| and 1 is returned. Otherwise zero is
507507
returned. |assert-return|
508508
The error is in the form "Expected {expected} but got
509-
{actual}". When {msg} is present it is prefixed to that.
509+
{actual}". When {msg} is present it is prefixed to that, along
510+
with the location of the assert when run from a script.
510511

511512
There is no automatic conversion, the String "4" is different
512513
from the Number 4. And the number 4 is different from the
513514
Float 4.0. The value of 'ignorecase' is not used here, case
514515
always matters.
515516
Example: >
516-
assert_equal('foo', 'bar')
517-
< Will result in a string to be added to |v:errors|:
518-
test.vim line 12: Expected 'foo' but got 'bar' ~
517+
call assert_equal('foo', 'bar', 'baz')
518+
< Will add the following to |v:errors|:
519+
test.vim line 12: baz: Expected 'foo' but got 'bar' ~
519520

520521
Can also be used as a |method|, the base is passed as the
521522
second argument: >
@@ -599,7 +600,8 @@ assert_false({actual} [, {msg}]) *assert_false()*
599600
When {actual} is not false an error message is added to
600601
|v:errors|, like with |assert_equal()|.
601602
The error is in the form "Expected False but got {actual}".
602-
When {msg} is present it is prepended to that.
603+
When {msg} is present it is prepended to that, along
604+
with the location of the assert when run from a script.
603605
Also see |assert-return|.
604606

605607
A value is false when it is zero. When {actual} is not a
@@ -625,7 +627,8 @@ assert_match({pattern}, {actual} [, {msg}])
625627
When {pattern} does not match {actual} an error message is
626628
added to |v:errors|. Also see |assert-return|.
627629
The error is in the form "Pattern {pattern} does not match
628-
{actual}". When {msg} is present it is prefixed to that.
630+
{actual}". When {msg} is present it is prefixed to that,
631+
along with the location of the assert when run from a script.
629632

630633
{pattern} is used as with |=~|: The matching is always done
631634
like 'magic' was set and 'cpoptions' is empty, no matter what
@@ -636,7 +639,7 @@ assert_match({pattern}, {actual} [, {msg}])
636639
Use both to match the whole text.
637640

638641
Example: >
639-
assert_match('^f.*o$', 'foobar')
642+
assert_match('^f.*o$', 'foobar')
640643
< Will result in a string to be added to |v:errors|:
641644
test.vim line 12: Pattern '^f.*o$' does not match 'foobar' ~
642645

@@ -693,7 +696,8 @@ assert_true({actual} [, {msg}]) *assert_true()*
693696
Also see |assert-return|.
694697
A value is TRUE when it is a non-zero number. When {actual}
695698
is not a number the assert fails.
696-
When {msg} is given it precedes the default message.
699+
When {msg} is given it precedes the default message, along
700+
with the location of the assert when run from a script.
697701

698702
Can also be used as a |method|: >
699703
GetResult()->assert_true()

runtime/doc/various.txt

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
*various.txt* For Vim version 9.1. Last change: 2024 Jun 17
1+
*various.txt* For Vim version 9.1. Last change: 2024 Jul 17
22

33

44
VIM REFERENCE MANUAL by Bram Moolenaar
@@ -19,9 +19,8 @@ CTRL-L Clear and redraw the screen. The redraw may happen
1919
*:redr* *:redraw*
2020
:redr[aw][!] Redraw the screen right now. When ! is included it is
2121
cleared first.
22-
Useful to update the screen halfway executing a script
23-
or function. Also when halfway a mapping and
24-
'lazyredraw' is set.
22+
It can be used to redraw the screen in a script
23+
or function (or a mapping if |'lazyredraw'| is set).
2524

2625
*:redraws* *:redrawstatus*
2726
:redraws[tatus][!] Redraw the status line of the current window. When !

0 commit comments

Comments
 (0)