runtime(doc): clarify complete_match() and 'isexpand' option
clarify complete_match() documentation to better explain its backward
search behavior, argument handling, and return value format and add an
example of isexpand
closes: #17212
Signed-off-by: glepnir <glephunter@gmail.com>
Signed-off-by: Christian Brabandt <cb@256bit.org>
diff --git a/runtime/doc/builtin.txt b/runtime/doc/builtin.txt
index 9f91f47..55a0731 100644
--- a/runtime/doc/builtin.txt
+++ b/runtime/doc/builtin.txt
@@ -1,4 +1,4 @@
-*builtin.txt* For Vim version 9.1. Last change: 2025 Apr 24
+*builtin.txt* For Vim version 9.1. Last change: 2025 Apr 27
VIM REFERENCE MANUAL by Bram Moolenaar
@@ -2034,8 +2034,11 @@
Return type: dict<any>
complete_match([{lnum}, {col}]) *complete_match()*
- Returns a List of matches found according to the 'isexpand'
- option. Each match is represented as a List containing
+ Searches backward from the given position and returns a List
+ of matches according to the 'isexpand' option. When no
+ arguments are provided, uses the current cursor position.
+
+ Each match is represented as a List containing
[startcol, trigger_text] where:
- startcol: column position where completion should start,
or -1 if no trigger position is found. For multi-character
@@ -2047,9 +2050,6 @@
When 'isexpand' is empty, uses the 'iskeyword' pattern
"\k\+$" to find the start of the current keyword.
- When no arguments are provided, uses the current cursor
- position.
-
Examples: >
set isexpand=.,->,/,/*,abc
func CustomComplete()