diff options
author | Justin M. Keyes <justinkz@gmail.com> | 2019-08-27 05:19:25 +0200 |
---|---|---|
committer | Justin M. Keyes <justinkz@gmail.com> | 2019-08-27 22:14:52 +0200 |
commit | 87389c6a57cf9fa91746503c479cdbea348030b9 (patch) | |
tree | 97f9cfa3d464b62add16fd2994a44935c567b005 /runtime/doc/if_lua.txt | |
parent | ed60015266356b3c0c42aa34698d9287f22fcba1 (diff) | |
download | rneovim-87389c6a57cf9fa91746503c479cdbea348030b9.tar.gz rneovim-87389c6a57cf9fa91746503c479cdbea348030b9.tar.bz2 rneovim-87389c6a57cf9fa91746503c479cdbea348030b9.zip |
paste: make vim.paste() "public"
Diffstat (limited to 'runtime/doc/if_lua.txt')
-rw-r--r-- | runtime/doc/if_lua.txt | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/runtime/doc/if_lua.txt b/runtime/doc/if_lua.txt index a9b8c5fae8..1837e14623 100644 --- a/runtime/doc/if_lua.txt +++ b/runtime/doc/if_lua.txt @@ -533,6 +533,25 @@ inspect({object}, {options}) *vim.inspect()* See also: ~ https://github.com/kikito/inspect.lua +paste({lines}, {phase}) *vim.paste()* + Paste handler, invoked by |nvim_paste()| when a conforming UI + (such as the |TUI|) pastes text into the editor. + + Parameters: ~ + {lines} |readfile()|-style list of lines to paste. + |channel-lines| + {phase} -1: "non-streaming" paste: the call contains all + lines. If paste is "streamed", `phase` indicates the stream state: + • 1: starts the paste (exactly once) + • 2: continues the paste (zero or more times) + • 3: ends the paste (exactly once) + + Return: ~ + false if client should cancel the paste. + + See also: ~ + |paste| + |