]> git.ipfire.org Git - thirdparty/vim.git/commitdiff
runtime(doc): clarify complete_match() and 'isexpand' option
authorglepnir <glephunter@gmail.com>
Sun, 27 Apr 2025 12:59:17 +0000 (14:59 +0200)
committerChristian Brabandt <cb@256bit.org>
Sun, 27 Apr 2025 12:59:17 +0000 (14:59 +0200)
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>
runtime/doc/builtin.txt
runtime/doc/options.txt

index 9f91f47d4212eeddbf328dccfd678f27311c7599..55a0731a81e181fb4eeef393bc58d90c6809dad7 100644 (file)
@@ -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 @@ complete_info([{what}])                          *complete_info()*
                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 @@ complete_match([{lnum}, {col}])                   *complete_match()*
                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()
index 03a6a6c5c3f26d347d1a8e2e9637100821a6cceb..255b9d50f9fa1187311b0a8810f7b84f2bc0360c 100644 (file)
@@ -1,4 +1,4 @@
-*options.txt*  For Vim version 9.1.  Last change: 2025 Apr 24
+*options.txt*  For Vim version 9.1.  Last change: 2025 Apr 27
 
 
                  VIM REFERENCE MANUAL    by Bram Moolenaar
@@ -4996,6 +4996,10 @@ A jump table for the options with a short description can be found at |Q_op|.
        Note: Use "\\," to add a literal comma as trigger character, see
        |option-backslash|.
 
+       Examples: >
+               set isexpand=.,->,/*,\\,
+<
+
                        *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
 'insertmode' 'im'      boolean (default off)
                        global