add note about nvim_call_function

nanotee · Apr 4, 2021 · 1561654 · 1561654
1 parent 9f9aea1
commit 1561654
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -724,6 +724,8 @@ vim.fn['my#autoload#function']()
 
 The functionality of `vim.fn` is identical to `vim.call`, but allows a more Lua-like syntax.
 
+It is distinct from `vim.api.nvim_call_function` in that converting Vim/Lua objects is automatic: `vim.api.nvim_call_function` returns a table for floating point numbers and does not accept Lua closures while `vim.fn` handles these types transparently.
+
 See also:
 - `:help vim.fn`
 

diff --git a/doc/nvim-lua-guide.txt b/doc/nvim-lua-guide.txt
@@ -881,6 +881,11 @@ Lua, so autoload functions have to be called with this syntax:
 The functionality of `vim.fn` is identical to `vim.call`, but allows a
 more Lua-like syntax.
 
+It is distinct from `vim.api.nvim_call_function` in that converting
+Vim/Lua objects is automatic: `vim.api.nvim_call_function` returns a
+table for floating point numbers and does not accept Lua closures while
+`vim.fn` handles these types transparently.
+
 See also:
 - |vim.fn|