commit e6b2255ac784913ff7da1ea670d28d3ba850f3a8
parent 7b9c063d116064bb0765c76277fe210c7ac01d0c
Author: zeertzjq <zeertzjq@outlook.com>
Date: Mon, 29 Sep 2025 06:17:37 +0800
vim-patch:4edaf89: runtime(doc): improve preinserted() doc
Change the second "if" to "because", otherwise it may be misinterpreted
that preinserted() can return non-zero just because these options are
set.
closes: vim/vim#18409
https://github.com/vim/vim/commit/4edaf8923335504c31810dc4c5213eaba84e7898
Diffstat:
3 files changed, 6 insertions(+), 6 deletions(-)
diff --git a/runtime/doc/vimfn.txt b/runtime/doc/vimfn.txt
@@ -7234,9 +7234,9 @@ pow({x}, {y}) *pow()*
preinserted() *preinserted()*
Returns non-zero if text has been inserted after the cursor
- because "preinsert" is present in 'completeopt', or if
+ because "preinsert" is present in 'completeopt', or because
"longest" is present in 'completeopt' while 'autocomplete'
- is enabled. Otherwise returns zero.
+ is active. Otherwise returns zero.
Return: ~
(`number`)
diff --git a/runtime/lua/vim/_meta/vimfn.lua b/runtime/lua/vim/_meta/vimfn.lua
@@ -6555,9 +6555,9 @@ function vim.fn.perleval(expr) end
function vim.fn.pow(x, y) end
--- Returns non-zero if text has been inserted after the cursor
---- because "preinsert" is present in 'completeopt', or if
+--- because "preinsert" is present in 'completeopt', or because
--- "longest" is present in 'completeopt' while 'autocomplete'
---- is enabled. Otherwise returns zero.
+--- is active. Otherwise returns zero.
---
--- @return number
function vim.fn.preinserted() end
diff --git a/src/nvim/eval.lua b/src/nvim/eval.lua
@@ -8027,9 +8027,9 @@ M.funcs = {
preinserted = {
desc = [=[
Returns non-zero if text has been inserted after the cursor
- because "preinsert" is present in 'completeopt', or if
+ because "preinsert" is present in 'completeopt', or because
"longest" is present in 'completeopt' while 'autocomplete'
- is enabled. Otherwise returns zero.
+ is active. Otherwise returns zero.
]=],
name = 'preinserted',
params = {},