commit c4ecb7256b6c2e33e4185914cd1d258db30c8760
parent aa33ea86e1ce37e0d8bf4d52630c446aafcced6c
Author: zeertzjq <zeertzjq@outlook.com>
Date: Thu, 11 Sep 2025 07:19:49 +0800
vim-patch:b2c8848: runtime(doc): improve docs related to 'autocomplete'
Manual completion can still be used when 'autocomplete' is set, so
saying "active" is better than "enabled".
closes: vim/vim#18261
https://github.com/vim/vim/commit/b2c88480553de7a7dc247fe8e361c8365eb4edec
Diffstat:
4 files changed, 14 insertions(+), 14 deletions(-)
diff --git a/runtime/doc/insert.txt b/runtime/doc/insert.txt
@@ -1134,7 +1134,7 @@ autocompletion. To use |i_CTRL-N| or |i_CTRL-X_CTRL-N| specifically, press
|CTRL-E| first to dismiss the popup menu (see |complete_CTRL-E|).
*ins-autocompletion-example*
-Example setup~
+Example setup ~
A typical configuration for automatic completion with a popup menu: >
set autocomplete
set complete=.^5,w^5,b^5,u^5
diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt
@@ -1675,12 +1675,12 @@ A jump table for the options with a short description can be found at |Q_op|.
with "menu" or "menuone". Overrides "preview".
preinsert
- When autocompletion is not enabled, inserts the part of the
+ When 'autocomplete' is not active, inserts the part of the
first candidate word beyond the current completion leader,
- highlighted with |hl-PreInsert|. The cursor does not
- move. Requires "fuzzy" unset and "menuone" in 'completeopt'.
+ highlighted with |hl-PreInsert|. The cursor doesn't move.
+ Requires "fuzzy" unset and "menuone" in 'completeopt'.
- When 'autocomplete' is enabled, inserts the longest common
+ When 'autocomplete' is active, inserts the longest common
prefix of matches (from all shown items or from the
current buffer items). This occurs only when no menu item
is selected. Press CTRL-Y to accept.
diff --git a/runtime/lua/vim/_meta/options.lua b/runtime/lua/vim/_meta/options.lua
@@ -1218,12 +1218,12 @@ vim.go.cia = vim.go.completeitemalign
--- with "menu" or "menuone". Overrides "preview".
---
--- preinsert
---- When autocompletion is not enabled, inserts the part of the
+--- When 'autocomplete' is not active, inserts the part of the
--- first candidate word beyond the current completion leader,
---- highlighted with `hl-PreInsert`. The cursor does not
---- move. Requires "fuzzy" unset and "menuone" in 'completeopt'.
+--- highlighted with `hl-PreInsert`. The cursor doesn't move.
+--- Requires "fuzzy" unset and "menuone" in 'completeopt'.
---
---- When 'autocomplete' is enabled, inserts the longest common
+--- When 'autocomplete' is active, inserts the longest common
--- prefix of matches (from all shown items or from the
--- current buffer items). This occurs only when no menu item
--- is selected. Press CTRL-Y to accept.
diff --git a/src/nvim/options.lua b/src/nvim/options.lua
@@ -1,4 +1,4 @@
--- vim: tw=80
+-- vim: tw=78
--- @class vim.option_meta
--- @field full_name string
@@ -1700,12 +1700,12 @@ local options = {
with "menu" or "menuone". Overrides "preview".
preinsert
- When autocompletion is not enabled, inserts the part of the
+ When 'autocomplete' is not active, inserts the part of the
first candidate word beyond the current completion leader,
- highlighted with |hl-PreInsert|. The cursor does not
- move. Requires "fuzzy" unset and "menuone" in 'completeopt'.
+ highlighted with |hl-PreInsert|. The cursor doesn't move.
+ Requires "fuzzy" unset and "menuone" in 'completeopt'.
- When 'autocomplete' is enabled, inserts the longest common
+ When 'autocomplete' is active, inserts the longest common
prefix of matches (from all shown items or from the
current buffer items). This occurs only when no menu item
is selected. Press CTRL-Y to accept.
