aboutsummaryrefslogtreecommitdiff
path: root/runtime
diff options
context:
space:
mode:
authorJustin M. Keyes <justinkz@gmail.com>2016-04-27 00:04:36 -0400
committerJustin M. Keyes <justinkz@gmail.com>2016-04-27 00:04:36 -0400
commit2adb8acebd1b50d6259834082d5a21788c0e3eeb (patch)
treec117823609fe8c8c366c88e545d7bb05e4307003 /runtime
parentec916bb9834bd7778e2b1b311e0529cf739b7f2b (diff)
parente4146dd7df0f1ba932a01a79d6dd511914763c72 (diff)
downloadrneovim-2adb8acebd1b50d6259834082d5a21788c0e3eeb.tar.gz
rneovim-2adb8acebd1b50d6259834082d5a21788c0e3eeb.tar.bz2
rneovim-2adb8acebd1b50d6259834082d5a21788c0e3eeb.zip
Merge pull request #4649 from justinmk/vimpatches
vim-patch:7.4.1092
Diffstat (limited to 'runtime')
-rw-r--r--runtime/doc/eval.txt24
1 files changed, 19 insertions, 5 deletions
diff --git a/runtime/doc/eval.txt b/runtime/doc/eval.txt
index e341a2247a..933c4decee 100644
--- a/runtime/doc/eval.txt
+++ b/runtime/doc/eval.txt
@@ -1788,9 +1788,10 @@ arglistid( [{winnr} [, {tabnr}]])
Number argument list id
argv( {nr}) String {nr} entry of the argument list
argv( ) List the argument list
-assert_equal( {exp}, {act} [, {msg}]) none assert that {exp} equals {act}
-assert_false( {actual} [, {msg}]) none assert that {actual} is false
-assert_true( {actual} [, {msg}]) none assert that {actual} is true
+assert_equal( {exp}, {act} [, {msg}]) none assert {exp} equals {act}
+assert_exception({error} [, {msg}]) none assert {error} is in v:exception
+assert_false( {actual} [, {msg}]) none assert {actual} is false
+assert_true( {actual} [, {msg}]) none assert {actual} is true
asin( {expr}) Float arc sine of {expr}
atan( {expr}) Float arc tangent of {expr}
atan2( {expr}, {expr}) Float arc tangent of {expr1} / {expr2}
@@ -2244,7 +2245,20 @@ assert_equal({expected}, {actual}, [, {msg}])
< Will result in a string to be added to |v:errors|:
test.vim line 12: Expected 'foo' but got 'bar' ~
-assert_false({actual}, [, {msg}]) *assert_false()*
+assert_exception({error} [, {msg}]) *assert_exception()*
+ When v:exception does not contain the string {error} an error
+ message is added to |v:errors|.
+ This can be used to assert that a command throws an exception.
+ Using the error number, followed by a colon, avoids problems
+ with translations: >
+ try
+ commandthatfails
+ call assert_false(1, 'command should have failed')
+ catch
+ call assert_exception('E492:')
+ endtry
+
+assert_false({actual} [, {msg}]) *assert_false()*
When {actual} is not false an error message is added to
|v:errors|, like with |assert_equal()|.
A value is false when it is zero or |v:false|. When "{actual}"
@@ -2252,7 +2266,7 @@ assert_false({actual}, [, {msg}]) *assert_false()*
When {msg} is omitted an error in the form "Expected False but
got {actual}" is produced.
-assert_true({actual}, [, {msg}]) *assert_true()*
+assert_true({actual} [, {msg}]) *assert_true()*
When {actual} is not true an error message is added to
|v:errors|, like with |assert_equal()|.
A value is true when it is a non-zero number or |v:true|.