aboutsummaryrefslogtreecommitdiff
path: root/runtime/doc
diff options
context:
space:
mode:
Diffstat (limited to 'runtime/doc')
-rw-r--r--runtime/doc/lua.txt8
1 files changed, 7 insertions, 1 deletions
diff --git a/runtime/doc/lua.txt b/runtime/doc/lua.txt
index 150a3d18e9..0b6b8d05ed 100644
--- a/runtime/doc/lua.txt
+++ b/runtime/doc/lua.txt
@@ -1331,7 +1331,8 @@ defer_fn({fn}, {timeout}) *vim.defer_fn()*
Return: ~
timer luv timer object
-deprecate({name}, {alternative}, {version}, {plugin}) *vim.deprecate()*
+ *vim.deprecate()*
+deprecate({name}, {alternative}, {version}, {plugin}, {backtrace})
Display a deprecation notification to the user.
Parameters: ~
@@ -1342,6 +1343,8 @@ deprecate({name}, {alternative}, {version}, {plugin}) *vim.deprecate()*
function will be removed.
{plugin} string|nil Plugin name that the function
will be removed from. Defaults to "Nvim".
+ {backtrace} boolean|nil Prints backtrace. Defaults to
+ true.
inspect({object}, {options}) *vim.inspect()*
Return a human-readable representation of the given object.
@@ -1379,6 +1382,9 @@ notify_once({msg}, {level}, {opts}) *vim.notify_once()*
{opts} (table|nil) Optional parameters. Unused by
default.
+ Return: ~
+ (boolean) true if message was displayed, else false
+
on_key({fn}, {ns_id}) *vim.on_key()*
Adds Lua function {fn} with namespace id {ns_id} as a listener
to every, yes every, input key.