summaryrefslogtreecommitdiffstats
path: root/runtime/doc/testing.txt
diff options
context:
space:
mode:
authorBram Moolenaar <Bram@vim.org>2020-08-18 13:41:50 +0200
committerBram Moolenaar <Bram@vim.org>2020-08-18 13:41:50 +0200
commit1d634542cf5ebcd1d5d83bd124b3e1d5e7c96c58 (patch)
treedd6ddcf92dd58de13a7e4ca9c12854ae449cb8a9 /runtime/doc/testing.txt
parent558813314d63dd0263a7a86c0496c1e89b5c8cba (diff)
patch 8.2.1479: Vim9: error for list index uses wrong line numberv8.2.1479
Problem: Vim9: error for list index uses wrong line number. Solution: Set source line number. (closes #6724) Add a way to assert the line number of the error with assert_fails().
Diffstat (limited to 'runtime/doc/testing.txt')
-rw-r--r--runtime/doc/testing.txt15
1 files changed, 12 insertions, 3 deletions
diff --git a/runtime/doc/testing.txt b/runtime/doc/testing.txt
index 15c5498a51..74b705c14e 100644
--- a/runtime/doc/testing.txt
+++ b/runtime/doc/testing.txt
@@ -291,8 +291,9 @@ assert_exception({error} [, {msg}]) *assert_exception()*
catch
call assert_exception('E492:')
endtry
-
-assert_fails({cmd} [, {error} [, {msg}]]) *assert_fails()*
+<
+ *assert_fails()*
+assert_fails({cmd} [, {error} [, {msg} [, {lnum}]]])
Run {cmd} and add an error message to |v:errors| if it does
NOT produce an error or when {error} is not found in the
error message. Also see |assert-return|.
@@ -311,13 +312,21 @@ assert_fails({cmd} [, {error} [, {msg}]]) *assert_fails()*
string for the first error: >
assert_fails('cmd', ['', 'E987:'])
<
+ If {msg} is empty then it is not used. Do this to get the
+ default message when passing the {lnum} argument.
+
+ When {lnum} is present and not negative, and the {error}
+ argument is present and matches, then this is compared with
+ the line number at which the error was reported. That can be
+ the line number in a function or in a script.
+
Note that beeping is not considered an error, and some failing
commands only beep. Use |assert_beeps()| for those.
Can also be used as a |method|: >
GetCmd()->assert_fails('E99:')
-assert_false({actual} [, {msg}]) *assert_false()*
+assert_false({actual} [, {msg}]) *assert_false()*
When {actual} is not false an error message is added to
|v:errors|, like with |assert_equal()|.
Also see |assert-return|.