Update runtime files.
diff --git a/runtime/doc/builtin.txt b/runtime/doc/builtin.txt
index e24bac8..b2e276e 100644
--- a/runtime/doc/builtin.txt
+++ b/runtime/doc/builtin.txt
@@ -5107,7 +5107,7 @@
When {expr} is a |Blob| the number of bytes is returned.
When {expr} is a |Dictionary| the number of entries in the
|Dictionary| is returned.
- Otherwise an error is given.
+ Otherwise an error is given and returns zero.
Can also be used as a |method|: >
mylist->len()
@@ -5200,6 +5200,7 @@
|getpos()|.
With the optional {winid} argument the values are obtained for
that window instead of the current window.
+ Returns 0 for invalid values of {expr} and {winid}.
Examples: >
line(".") line number of the cursor
line(".", winid) idem, in window "winid"
@@ -5267,6 +5268,8 @@
With UTF-8 composing characters work as expected: >
list2str([97, 769]) returns "á"
<
+ Returns an empty string on error.
+
Can also be used as a |method|: >
GetList()->list2str()
@@ -5339,6 +5342,8 @@
The {callback} is also not invoked when the buffer is
unloaded, use the |BufUnload| autocmd event for that.
+ Returns zero if {callback} or {buf} is invalid.
+
Can also be used as a |method|, the base is passed as the
second argument: >
GetBuffer()->listener_add(callback)
@@ -5371,6 +5376,7 @@
Return the natural logarithm (base e) of {expr} as a |Float|.
{expr} must evaluate to a |Float| or a |Number| in the range
(0, inf].
+ Returns 0.0 if {expr} is not a |Float| or a |Number|.
Examples: >
:echo log(10)
< 2.302585 >
@@ -5386,6 +5392,7 @@
log10({expr}) *log10()*
Return the logarithm of Float {expr} to base 10 as a |Float|.
{expr} must evaluate to a |Float| or a |Number|.
+ Returns 0.0 if {expr} is not a |Float| or a |Number|.
Examples: >
:echo log10(1000)
< 3.0 >
@@ -5484,8 +5491,9 @@
below. To get a list of all mappings see |maplist()|.
When there is no mapping for {name}, an empty String is
- returned. When the mapping for {name} is empty, then "<Nop>"
- is returned.
+ returned if {dict} is FALSE, otherwise returns an empty Dict.
+ When the mapping for {name} is empty, then "<Nop>" is
+ returned.
The {name} can have special key names, like in the ":map"
command.
@@ -5778,6 +5786,8 @@
The number of matches is not limited, as it is the case with
the |:match| commands.
+ Returns -1 on error.
+
Example: >
:highlight MyGroup ctermbg=green guibg=green
:let m = matchadd("MyGroup", "TODO")
@@ -5816,6 +5826,8 @@
The maximum number of positions in {pos} is 8.
+ Returns -1 on error.
+
Example: >
:highlight MyGroup ctermbg=green guibg=green
:let m = matchaddpos("MyGroup", [[23, 24], 34])
@@ -6285,6 +6297,7 @@
:echo pathshorten('~/.vim/autoload/myfile.vim', 2)
< ~/.vi/au/myfile.vim ~
It doesn't matter if the path exists or not.
+ Returns an empty string on error.
Can also be used as a |method|: >
GetDirectories()->pathshorten()
@@ -6314,6 +6327,7 @@
pow({x}, {y}) *pow()*
Return the power of {x} to the exponent {y} as a |Float|.
{x} and {y} must evaluate to a |Float| or a |Number|.
+ Returns 0.0 if {x} or {y} is not a |Float| or a |Number|.
Examples: >
:echo pow(3, 3)
< 27.0 >
@@ -6690,6 +6704,7 @@
{expr} can be initialized by |srand()| and will be updated by
rand(). If {expr} is omitted, an internal seed value is used
and updated.
+ Returns -1 if {expr} is invalid.
Examples: >
:echo rand()
@@ -6779,6 +6794,8 @@
endfunction
echo s:tree(".")
<
+ Returns an empty List on error.
+
Can also be used as a |method|: >
GetDirName()->readdir()
<
@@ -6837,7 +6854,6 @@
For example, to get a list of all files in the current
directory without sorting the individual entries: >
readdirex(dirname, '1', #{sort: 'none'})
-
<
Can also be used as a |method|: >
GetDirName()->readdirex()
@@ -6927,8 +6943,8 @@
and {end}.
The {start} and {end} arguments must be values returned by
- reltime(). If there is an error zero is returned in legacy
- script, in Vim9 script an error is given.
+ reltime(). If there is an error an empty List is returned in
+ legacy script, in Vim9 script an error is given.
Can also be used as a |method|: >
GetStart()->reltime()
@@ -7047,7 +7063,8 @@
remote_read({serverid}, [{timeout}]) *remote_read()*
Return the oldest available reply from {serverid} and consume
it. Unless a {timeout} in seconds is given, it blocks until a
- reply is available.
+ reply is available. Returns an empty string, if a reply is
+ not available or on error.
See also |clientserver|.
This function is not available in the |sandbox|.
{only available when compiled with the |+clientserver| feature}
@@ -7106,6 +7123,7 @@
item as {end} a list with one item is returned. When {end}
points to an item before {idx} this is an error.
See |list-index| for possible values of {idx} and {end}.
+ Returns zero on error.
Example: >
:echo "last item: " .. remove(mylist, -1)
:call remove(mylist, 0, 9)
@@ -7122,6 +7140,7 @@
return a |Blob| with these bytes. When {idx} points to the same
byte as {end} a |Blob| with one byte is returned. When {end}
points to a byte before {idx} this is an error.
+ Returns zero on error.
Example: >
:echo "last byte: " .. remove(myblob, -1)
:call remove(mylist, 0, 9)
@@ -7131,6 +7150,7 @@
Example: >
:echo "removed " .. remove(dict, "one")
< If there is no {key} in {dict} this is an error.
+ Returns zero on error.
rename({from}, {to}) *rename()*
Rename the file by the name {from} to the name {to}. This
@@ -7179,6 +7199,7 @@
Reverse the order of items in {object} in-place.
{object} can be a |List| or a |Blob|.
Returns {object}.
+ Returns zero if {object} is not a List or a Blob.
If you want an object to remain unmodified make a copy first: >
:let revlist = reverse(copy(mylist))
< Can also be used as a |method|: >
@@ -7189,6 +7210,7 @@
as a |Float|. If {expr} lies halfway between two integral
values, then use the larger one (away from zero).
{expr} must evaluate to a |Float| or a |Number|.
+ Returns 0.0 if {expr} is not a |Float| or a |Number|.
Examples: >
echo round(0.456)
< 0.0 >
@@ -7223,6 +7245,7 @@
Like |screenchar()|, but return the attribute. This is a rather
arbitrary number that can only be used to compare to the
attribute at other positions.
+ Returns -1 when row or col is out of range.
Can also be used as a |method|: >
GetRow()->screenattr(col)
@@ -7286,6 +7309,7 @@
|conceal| taken into account.
If the position is in a closed fold the screen position of the
first character is returned, {col} is not used.
+ Returns an empty Dict if {winid} is invalid.
Can also be used as a |method|: >
GetWinid()->screenpos(lnum, col)
@@ -8346,6 +8370,7 @@
sin({expr}) *sin()*
Return the sine of {expr}, measured in radians, as a |Float|.
{expr} must evaluate to a |Float| or a |Number|.
+ Returns 0.0 if {expr} is not a |Float| or a |Number|.
Examples: >
:echo sin(100)
< -0.506366 >
@@ -8362,6 +8387,7 @@
Return the hyperbolic sine of {expr} as a |Float| in the range
[-inf, inf].
{expr} must evaluate to a |Float| or a |Number|.
+ Returns 0.0 if {expr} is not a |Float| or a |Number|.
Examples: >
:echo sinh(0.5)
< 0.521095 >
@@ -8381,6 +8407,7 @@
|vim9script|. Also, composing characters are not counted.
When {end} is omitted the slice continues to the last item.
When {end} is -1 the last item is omitted.
+ Returns an empty value if {start} or {end} are invalid.
Can also be used as a |method|: >
GetList()->slice(offset)
@@ -8626,7 +8653,8 @@
Return the non-negative square root of Float {expr} as a
|Float|.
{expr} must evaluate to a |Float| or a |Number|. When {expr}
- is negative the result is NaN (Not a Number).
+ is negative the result is NaN (Not a Number). Returns 0.0 if
+ {expr} is not a |Float| or a |Number|.
Examples: >
:echo sqrt(100)
< 10.0 >
@@ -8707,6 +8735,8 @@
|substitute()|: >
let f = str2float(substitute(text, ',', '', 'g'))
<
+ Returns 0.0 if the conversion fails.
+
Can also be used as a |method|: >
let f = text->substitute(',', '', 'g')->str2float()
<
@@ -8746,6 +8776,8 @@
{base} is 2 a leading "0b" or "0B" is ignored.
Text after the number is silently ignored.
+ Returns 0 if {string} is empty or on error.
+
Can also be used as a |method|: >
GetText()->str2nr()
@@ -8756,6 +8788,8 @@
|strchars()| can count the number of characters, counting
composing characters separately.
+ Returns 0 if {string} is empty or on error.
+
Also see |strlen()|, |strdisplaywidth()| and |strwidth()|.
Can also be used as a |method|: >
diff --git a/runtime/doc/index.txt b/runtime/doc/index.txt
index 190ce7c..8be4c62 100644
--- a/runtime/doc/index.txt
+++ b/runtime/doc/index.txt
@@ -1,4 +1,4 @@
-*index.txt* For Vim version 8.2. Last change: 2022 Mar 05
+*index.txt* For Vim version 8.2. Last change: 2022 Jun 11
VIM REFERENCE MANUAL by Bram Moolenaar
@@ -295,7 +295,7 @@
|/| /{pattern}<CR> 1 search forward for the Nth occurrence of
{pattern}
|/<CR>| /<CR> 1 search forward for {pattern} of last search
-|count| 0 1 cursor to the first char of the line
+|0| 0 1 cursor to the first char of the line
|count| 1 prepend to command to give a count
|count| 2 "
|count| 3 "
diff --git a/runtime/doc/syntax.txt b/runtime/doc/syntax.txt
index 38a4a1c..e75f870 100644
--- a/runtime/doc/syntax.txt
+++ b/runtime/doc/syntax.txt
@@ -1,4 +1,4 @@
-*syntax.txt* For Vim version 8.2. Last change: 2022 Jun 03
+*syntax.txt* For Vim version 8.2. Last change: 2022 Jun 10
VIM REFERENCE MANUAL by Bram Moolenaar
@@ -5395,8 +5395,8 @@
*hl-StatusLineTerm*
StatusLineTerm Status line of current window, if it is a |terminal| window.
*hl-StatusLineTermNC*
-StatusLineTermNC Status lines of not-current windows that is a |terminal|
- window.
+StatusLineTermNC Status lines of not-current windows that is a
+ |terminal| window.
*hl-TabLine*
TabLine Tab pages line, not active tab page label.
*hl-TabLineFill*
diff --git a/runtime/doc/todo.txt b/runtime/doc/todo.txt
index bd86b20..d880553 100644
--- a/runtime/doc/todo.txt
+++ b/runtime/doc/todo.txt
@@ -1,4 +1,4 @@
-*todo.txt* For Vim version 8.2. Last change: 2022 Jun 09
+*todo.txt* For Vim version 8.2. Last change: 2022 Jun 12
VIM REFERENCE MANUAL by Bram Moolenaar
@@ -38,6 +38,9 @@
*known-bugs*
-------------------- Known bugs and current work -----------------------
+searchpair() must call function to set timeout, not pass the time limit down
+(and set it many times). #10562
+
Prepare for Vim 9.0 release:
- Update the user manual:
- Add more to usr_50.txt as an "advanced section" of usr_41.txt
diff --git a/runtime/doc/usr_41.txt b/runtime/doc/usr_41.txt
index ba3cd2e..e2dc463 100644
--- a/runtime/doc/usr_41.txt
+++ b/runtime/doc/usr_41.txt
@@ -1,4 +1,4 @@
-*usr_41.txt* For Vim version 8.2. Last change: 2022 Jun 04
+*usr_41.txt* For Vim version 8.2. Last change: 2022 Jun 10
VIM USER MANUAL - by Bram Moolenaar
@@ -1509,7 +1509,7 @@
function SetSyn(name) ~
The "<SNR>" prefix means that a function is script-local. |Vim9| functions
-wil start with "def" and include argument and return types. Legacy functions
+will start with "def" and include argument and return types. Legacy functions
are listed with "function".
To see what a function does, use its name as an argument for `function`: >
@@ -1667,7 +1667,7 @@
last item is one less than the length of the list. Detail: Internally range()
does not actually create the list, so that a large range used in a for loop
works efficiently. When used elsewhere, the range is turned into an actual
-list, which takes more time for a long ist.
+list, which takes more time for a long list.
You can also specify the maximum value, the stride and even go backwards: >
diff --git a/runtime/doc/vim9.txt b/runtime/doc/vim9.txt
index 9cd90d5..9b7c8dc 100644
--- a/runtime/doc/vim9.txt
+++ b/runtime/doc/vim9.txt
@@ -1,4 +1,4 @@
-*vim9.txt* For Vim version 8.2. Last change: 2022 May 21
+*vim9.txt* For Vim version 8.2. Last change: 2022 Jun 10
VIM REFERENCE MANUAL by Bram Moolenaar
@@ -1612,7 +1612,7 @@
This mechanism exists for writing a script that can be sourced (imported) by
other scripts, while making sure these other scripts only have access to what
you want them to. This also avoids using the global namespace, which has a
-risc of name collisions. For example when you have two plugins with similar
+risk of name collisions. For example when you have two plugins with similar
functionality.
You can cheat by using the global namespace explicitly. That should be done
@@ -1758,7 +1758,9 @@
When the mapping is defined "<SID>name." will be replaced with <SNR> and the
script ID of the imported script.
-
+An even simpler solution is using |<ScriptCmd>|: >
+ noremap ,a <ScriptCmd>name.Function()<CR>
+<
*:import-cycle*
The `import` commands are executed when encountered. If script A imports
script B, and B (directly or indirectly) imports A, this will be skipped over.
@@ -2202,7 +2204,7 @@
like real classes. On top of that, it's quite slow, because of the use of
dictionaries.
-It would be good to support real classes, and this is planned for a leter
+It would be good to support real classes, and this is planned for a later
version. The support is a "minimal common functionality" of class support in
most languages. It will work much like Java, which is the most popular
programming language.