aboutsummaryrefslogtreecommitdiff
path: root/src/nvim/api/vim.c
diff options
context:
space:
mode:
authorJustin M. Keyes <justinkz@gmail.com>2017-08-19 14:13:14 +0200
committerJustin M. Keyes <justinkz@gmail.com>2017-11-06 01:56:04 +0100
commit842a54a1bbdd3724ba9283269b3f9899b3844e35 (patch)
tree2ba7f8a8a49b9d8261d90d9d3b85b223abf52244 /src/nvim/api/vim.c
parent04b3c327723587fa63f391884b8dfce44233cc77 (diff)
downloadrneovim-842a54a1bbdd3724ba9283269b3f9899b3844e35.tar.gz
rneovim-842a54a1bbdd3724ba9283269b3f9899b3844e35.tar.bz2
rneovim-842a54a1bbdd3724ba9283269b3f9899b3844e35.zip
doc
Diffstat (limited to 'src/nvim/api/vim.c')
-rw-r--r--src/nvim/api/vim.c5
1 files changed, 4 insertions, 1 deletions
diff --git a/src/nvim/api/vim.c b/src/nvim/api/vim.c
index 98f4410347..86f4a9d008 100644
--- a/src/nvim/api/vim.c
+++ b/src/nvim/api/vim.c
@@ -166,7 +166,10 @@ void nvim_feedkeys(String keys, String mode, Boolean escape_csi)
/// On VimL error: Does not fail, but updates v:errmsg.
///
/// Unlike `nvim_feedkeys`, this uses a lower-level input buffer and the call
-/// is not deferred. This is the most reliable way to emulate real user input.
+/// is not deferred. This is the most reliable way to send real user input.
+///
+/// @note |keycodes| like <CR> are translated, so `<` is special.
+/// To input a literal `<`, send `<LT>`.
///
/// @param keys to be typed
/// @return Number of bytes actually written (can be fewer than