adam/vim
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

runtime(doc): minor updates.

Browse Source 
closes: #15280

Signed-off-by: Shane Harper <shane@shaneharper.net>
Signed-off-by: Christian Brabandt <cb@256bit.org>
This commit is contained in:
Shane Harper
2024-07-17 19:40:40 +02:00
committed by Christian Brabandt
parent 080ba2c69d
commit c1b3984a7b
7 changed files with 36 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
runtime/doc/testing.txt
View 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()