aboutsummaryrefslogtreecommitdiff
path: root/runtime/doc/lua.txt
diff options
context:
space:
mode:
authorJustin M. Keyes <justinkz@gmail.com>2021-09-10 07:05:11 -0700
committerGitHub <noreply@github.com>2021-09-10 07:05:11 -0700
commit7b822d4b4b71ef0e9ed6a39ef50a5a2cbf8660c5 (patch)
tree1e58317059af6850e9f06289f33fbb3f61d8cf63 /runtime/doc/lua.txt
parentc7ccb26260e763cd5fde5f635da6889c736262fd (diff)
parent329047b3dbd09f7d77cdc07002c532c230e44ddb (diff)
downloadrneovim-7b822d4b4b71ef0e9ed6a39ef50a5a2cbf8660c5.tar.gz
rneovim-7b822d4b4b71ef0e9ed6a39ef50a5a2cbf8660c5.tar.bz2
rneovim-7b822d4b4b71ef0e9ed6a39ef50a5a2cbf8660c5.zip
Merge branch 'master' into histfile
Diffstat (limited to 'runtime/doc/lua.txt')
-rw-r--r--runtime/doc/lua.txt14
1 files changed, 12 insertions, 2 deletions
diff --git a/runtime/doc/lua.txt b/runtime/doc/lua.txt
index 3fd3875557..5731569947 100644
--- a/runtime/doc/lua.txt
+++ b/runtime/doc/lua.txt
@@ -907,7 +907,7 @@ vim.fn.{func}({...}) *vim.fn*
To call autoload functions, use the syntax: >
vim.fn['some#function']({...})
<
- Unlike vim.api.|nvim_call_function| this converts directly between Vim
+ Unlike vim.api.|nvim_call_function()| this converts directly between Vim
objects and Lua objects. If the Vim function returns a float, it will
be represented directly as a Lua number. Empty lists and dictionaries
both are represented by an empty table.
@@ -1268,7 +1268,17 @@ schedule_wrap({cb}) *vim.schedule_wrap()*
deep_equal({a}, {b}) *vim.deep_equal()*
- TODO: Documentation
+ Deep compare values for equality
+
+ Tables are compared recursively unless they both provide the `eq` methamethod.
+ All other types are compared using the equality `==` operator.
+
+ Parameters: ~
+ {a} first value
+ {b} second value
+
+ Return: ~
+ `true` if values are equals, else `false` .
deepcopy({orig}) *vim.deepcopy()*
Returns a deep copy of the given object. Non-table objects are