aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBjörn Linse <bjorn.linse@gmail.com>2021-03-06 13:17:42 +0100
committerGitHub <noreply@github.com>2021-03-06 13:17:42 +0100
commit399b47fddbd942cc32ebcf9e08799c9544b4d5fe (patch)
treed920f878950a85ce0f2b0b7fcbf88fdfb53b5528
parent3fbff98cfd48941ceac086543dd7d6bcdbfb18ab (diff)
parentd8dff33e4be1288f675256db3257d3de0da0daed (diff)
downloadrneovim-399b47fddbd942cc32ebcf9e08799c9544b4d5fe.tar.gz
rneovim-399b47fddbd942cc32ebcf9e08799c9544b4d5fe.tar.bz2
rneovim-399b47fddbd942cc32ebcf9e08799c9544b4d5fe.zip
Merge pull request #14066 from LeeWannacott/clarify-nvim-put
Clarify that nvim_put()'s {after} and {follow} parameters expect boolean values true, or false.
-rw-r--r--runtime/doc/api.txt4
-rw-r--r--src/nvim/api/vim.c4
2 files changed, 4 insertions, 4 deletions
diff --git a/runtime/doc/api.txt b/runtime/doc/api.txt
index fdc41af1d5..bd34411065 100644
--- a/runtime/doc/api.txt
+++ b/runtime/doc/api.txt
@@ -1415,9 +1415,9 @@ nvim_put({lines}, {type}, {after}, {follow}) *nvim_put()*
• "c" |charwise| mode
• "l" |linewise| mode
• "" guess by contents, see |setreg()|
- {after} Insert after cursor (like |p|), or before (like
+ {after} If true insert after cursor (like |p|), or before (like
|P|).
- {follow} Place cursor at end of inserted text.
+ {follow} If true place cursor at end of inserted text.
*nvim_replace_termcodes()*
nvim_replace_termcodes({str}, {from_part}, {do_lt}, {special})
diff --git a/src/nvim/api/vim.c b/src/nvim/api/vim.c
index b94c99dc5e..586123aac1 100644
--- a/src/nvim/api/vim.c
+++ b/src/nvim/api/vim.c
@@ -1546,8 +1546,8 @@ theend:
/// - "c" |charwise| mode
/// - "l" |linewise| mode
/// - "" guess by contents, see |setreg()|
-/// @param after Insert after cursor (like |p|), or before (like |P|).
-/// @param follow Place cursor at end of inserted text.
+/// @param after If true insert after cursor (like |p|), or before (like |P|).
+/// @param follow If true place cursor at end of inserted text.
/// @param[out] err Error details, if any
void nvim_put(ArrayOf(String) lines, String type, Boolean after,
Boolean follow, Error *err)