aboutsummaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorChristian Clason <christian.clason@uni-due.de>2020-07-07 10:55:40 +0200
committerGitHub <noreply@github.com>2020-07-07 10:55:40 +0200
commit91572ddad185c2c4f6d266543d66919543c5bb2a (patch)
tree0a4a763c3970f6de5767f0b14f1b70fb4ff06f25 /src
parente49fc4ba1f27d968b2a104a14633459ad6091ca3 (diff)
downloadrneovim-91572ddad185c2c4f6d266543d66919543c5bb2a.tar.gz
rneovim-91572ddad185c2c4f6d266543d66919543c5bb2a.tar.bz2
rneovim-91572ddad185c2c4f6d266543d66919543c5bb2a.zip
doc: mention that defer_fn applies schedule_wrap (#12601)
Diffstat (limited to 'src')
-rw-r--r--src/nvim/lua/vim.lua2
1 files changed, 2 insertions, 0 deletions
diff --git a/src/nvim/lua/vim.lua b/src/nvim/lua/vim.lua
index 771ec971b7..18256242e8 100644
--- a/src/nvim/lua/vim.lua
+++ b/src/nvim/lua/vim.lua
@@ -467,6 +467,8 @@ end
--- Defers calling `fn` until `timeout` ms passes.
---
--- Use to do a one-shot timer that calls `fn`
+--- Note: The {fn} is |schedule_wrap|ped automatically, so API functions are
+--- safe to call.
--@param fn Callback to call once `timeout` expires
--@param timeout Number of milliseconds to wait before calling `fn`
--@return timer luv timer object