From fc3c204bbe48d34bded70d2b190c3b1e1f9f89b7 Mon Sep 17 00:00:00 2001 From: veotos Date: Sun, 10 Aug 2025 09:27:17 +0200 Subject: [PATCH] runtime(doc): Fix style and typos in builtin.txt and usr_41.txt - Reformat parts to fit into 80 column window. - Fix example with mandatory call with a range. https://github.com/vim/vim/discussions/17950#discussioncomment-14055687 - Remove some duplicate information closes: #17949 Signed-off-by: veotos Signed-off-by: Christian Brabandt --- runtime/doc/builtin.txt | 29 ++++++++++++++++++----------- runtime/doc/usr_41.txt | 31 ++++++++++++++++--------------- 2 files changed, 34 insertions(+), 26 deletions(-) diff --git a/runtime/doc/builtin.txt b/runtime/doc/builtin.txt index f4409f39ad..9e2205af8e 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 Aug 08 +*builtin.txt* For Vim version 9.1. Last change: 2025 Aug 10 VIM REFERENCE MANUAL by Bram Moolenaar @@ -6556,7 +6556,7 @@ libcall({libname}, {funcname}, {argument}) libcallnr({libname}, {funcname}, {argument}) Just like |libcall()|, but used for a function that returns an int instead of a string. - {only in Win32 on some Unix versions, when the |+libcall| + {only in Win32 and some Unix versions, when the |+libcall| feature is present} Examples: > :echo libcallnr("/usr/lib/libc.so", "getpid", "") @@ -7350,14 +7350,16 @@ matchbufline({buf}, {pat}, {lnum}, {end}, [, {dict}]) [{'lnum': 3, 'byteidx': 0, 'text': 'a'}] " Assuming line 4 in buffer 10 contains "tik tok" :echo matchbufline(10, '\<\k\+\>', 1, 4) - [{'lnum': 4, 'byteidx': 0, 'text': 'tik'}, {'lnum': 4, 'byteidx': 4, 'text': 'tok'}] + [{'lnum': 4, 'byteidx': 0, 'text': 'tik'}, + {'lnum': 4, 'byteidx': 4, 'text': 'tok'}] < If {submatch} is present and is v:true, then submatches like "\1", "\2", etc. are also returned. Example: > " Assuming line 2 in buffer 2 contains "acd" :echo matchbufline(2, '\(a\)\?\(b\)\?\(c\)\?\(.*\)', 2, 2 \ {'submatches': v:true}) - [{'lnum': 2, 'byteidx': 0, 'text': 'acd', 'submatches': ['a', '', 'c', 'd', '', '', '', '', '']}] + [{'lnum': 2, 'byteidx': 0, 'text': 'acd', 'submatches': + ['a', '', 'c', 'd', '', '', '', '', '']}] < The "submatches" List always contains 9 items. If a submatch is not found, then an empty string is returned for that submatch. @@ -7494,7 +7496,8 @@ matchfuzzypos({list}, {str} [, {dict}]) *matchfuzzypos()* < results in [['testing'], [[0, 2, 6]], [99]] > :echo matchfuzzypos(['clay', 'lacy'], 'la') < results in [['lacy', 'clay'], [[0, 1], [1, 2]], [153, 133]] > - :echo [{'text': 'hello', 'id' : 10}]->matchfuzzypos('ll', {'key' : 'text'}) + :echo [{'text': 'hello', 'id' : 10}] + \ ->matchfuzzypos('ll', {'key' : 'text'}) < results in [[{'id': 10, 'text': 'hello'}], [[2, 3]], [127]] Return type: list> @@ -7538,15 +7541,18 @@ matchstrlist({list}, {pat} [, {dict}]) Example: > :echo matchstrlist(['tik tok'], '\<\k\+\>') - [{'idx': 0, 'byteidx': 0, 'text': 'tik'}, {'idx': 0, 'byteidx': 4, 'text': 'tok'}] + [{'idx': 0, 'byteidx': 0, 'text': 'tik'}, + {'idx': 0, 'byteidx': 4, 'text': 'tok'}] :echo matchstrlist(['a', 'b'], '\<\k\+\>') - [{'idx': 0, 'byteidx': 0, 'text': 'a'}, {'idx': 1, 'byteidx': 0, 'text': 'b'}] + [{'idx': 0, 'byteidx': 0, 'text': 'a'}, + {'idx': 1, 'byteidx': 0, 'text': 'b'}] < If "submatches" is present and is v:true, then submatches like "\1", "\2", etc. are also returned. Example: > :echo matchstrlist(['acd'], '\(a\)\?\(b\)\?\(c\)\?\(.*\)', \ #{submatches: v:true}) - [{'idx': 0, 'byteidx': 0, 'text': 'acd', 'submatches': ['a', '', 'c', 'd', '', '', '', '', '']}] + [{'idx': 0, 'byteidx': 0, 'text': 'acd', + 'submatches': ['a', '', 'c', 'd', '', '', '', '', '']}] < The "submatches" List always contains 9 items. If a submatch is not found, then an empty string is returned for that submatch. @@ -8956,8 +8962,8 @@ remote_send({server}, {string} [, {idvar}]) *remote_send()* *E241* Note: Any errors will be reported in the server and may mess up the display. Examples: > - :echo remote_send("gvim", ":DropAndReply " .. file, "serverid") .. - \ remote_read(serverid) + :echo remote_send("gvim", ":DropAndReply " .. file, + \ "serverid") .. remote_read(serverid) :autocmd NONE RemoteReply * \ echo remote_read(expand("")) @@ -13027,7 +13033,8 @@ python_dynamic Python 2.x interface is dynamically loaded. |has-python| python3 Python 3.x interface available. |has-python| python3_compiled Compiled with Python 3.x interface. |has-python| python3_dynamic Python 3.x interface is dynamically loaded. |has-python| -python3_stable Python 3.x interface is using Python Stable ABI. |has-python| +python3_stable Python 3.x interface is using Python Stable ABI. + |has-python| pythonx Python 2.x and/or 3.x interface available. |python_x| qnx QNX version of Vim. quickfix Compiled with |quickfix| support. diff --git a/runtime/doc/usr_41.txt b/runtime/doc/usr_41.txt index d263bed9ed..5543c03991 100644 --- a/runtime/doc/usr_41.txt +++ b/runtime/doc/usr_41.txt @@ -1,4 +1,4 @@ -*usr_41.txt* For Vim version 9.1. Last change: 2025 Jul 21 +*usr_41.txt* For Vim version 9.1. Last change: 2025 Aug 10 VIM USER MANUAL - by Bram Moolenaar @@ -30,10 +30,10 @@ Table of contents: |usr_toc.txt| *41.1* Introduction *vim-script-intro* *script* Let's start with some nomenclature. A Vim script is any file that Vim can -interpret and execute. This includes files written in Vim's scripting language -like for example .vim files or configuration files like .vimrc and .gvimrc. -These scripts may define functions, commands and settings that Vim uses to -customize and extend its behavior. +interpret and execute. This includes files written in Vim's scripting +language like for example .vim files or configuration files like .vimrc and +.gvimrc. These scripts may define functions, commands and settings that Vim +uses to customize and extend its behavior. *vim-script-notation* The correct notation is "Vim script" (or "Vim9 script" when refering to the @@ -125,8 +125,8 @@ make such a loop, it can be written much more compact: > echo $"count is {i}" endfor -We won't explain how `for`, `range()`and `$"string"` work until later. Follow -the links if you are impatient. +We won't explain how `for`, `range()` and `$"string"` work until later. +Follow the links if you are impatient. TRYING OUT EXAMPLES @@ -749,7 +749,7 @@ String manipulation: *string-functions* str2list() get list of numbers from a string str2nr() convert a string to a Number str2float() convert a string to a Float - printf() format a string according to % items + printf() format a string according to "%" items escape() escape characters in a string with a '\' shellescape() escape a string for use with a shell command fnameescape() escape a file name for use with a Vim command @@ -832,9 +832,8 @@ List manipulation: *list-functions* range() return a List with a sequence of numbers string() String representation of a List call() call a function with List as arguments - index() index of a value in a List or Blob - indexof() index in a List or Blob where an expression - evaluates to true + index() index of a value in a List + indexof() index in a List where an expression is true max() maximum value in a List min() minimum value in a List count() count number of times a value appears in a List @@ -918,6 +917,8 @@ Blob manipulation: *blob-functions* blob2list() get a list of numbers from a blob list2blob() get a blob from a list of numbers reverse() reverse the order of numbers in a blob + index() index of a value in a Blob + indexof() index in a Blob where an expression is true Other computation: *bitwise-function* and() bitwise AND @@ -1456,9 +1457,9 @@ Various: *various-functions* luaeval() evaluate |Lua| expression mzeval() evaluate |MzScheme| expression - perleval() evaluate Perl expression (|+perl|) - py3eval() evaluate Python expression (|+python3|) - pyeval() evaluate Python expression (|+python|) + perleval() evaluate Perl expression + py3eval() evaluate Python expression + pyeval() evaluate Python expression pyxeval() evaluate |python_x| expression rubyeval() evaluate |Ruby| expression @@ -1586,7 +1587,7 @@ once for every line in the range, with the cursor in that line. Example: > If you call this function with: > - :10,15Number() + :10,15 call Number() The function will be called six times, starting on line 10 and ending on line 15.