mirror of
https://github.com/vim/vim.git
synced 2025-09-23 03:43:49 -04:00
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 <veotos@users.noreply.github.com> Signed-off-by: Christian Brabandt <cb@256bit.org>
This commit is contained in:
committed by
Christian Brabandt
parent
8e2a229189
commit
fc3c204bbe
@@ -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
|
VIM REFERENCE MANUAL by Bram Moolenaar
|
||||||
@@ -6556,7 +6556,7 @@ libcall({libname}, {funcname}, {argument})
|
|||||||
libcallnr({libname}, {funcname}, {argument})
|
libcallnr({libname}, {funcname}, {argument})
|
||||||
Just like |libcall()|, but used for a function that returns an
|
Just like |libcall()|, but used for a function that returns an
|
||||||
int instead of a string.
|
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}
|
feature is present}
|
||||||
Examples: >
|
Examples: >
|
||||||
:echo libcallnr("/usr/lib/libc.so", "getpid", "")
|
:echo libcallnr("/usr/lib/libc.so", "getpid", "")
|
||||||
@@ -7350,14 +7350,16 @@ matchbufline({buf}, {pat}, {lnum}, {end}, [, {dict}])
|
|||||||
[{'lnum': 3, 'byteidx': 0, 'text': 'a'}]
|
[{'lnum': 3, 'byteidx': 0, 'text': 'a'}]
|
||||||
" Assuming line 4 in buffer 10 contains "tik tok"
|
" Assuming line 4 in buffer 10 contains "tik tok"
|
||||||
:echo matchbufline(10, '\<\k\+\>', 1, 4)
|
: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
|
If {submatch} is present and is v:true, then submatches like
|
||||||
"\1", "\2", etc. are also returned. Example: >
|
"\1", "\2", etc. are also returned. Example: >
|
||||||
" Assuming line 2 in buffer 2 contains "acd"
|
" Assuming line 2 in buffer 2 contains "acd"
|
||||||
:echo matchbufline(2, '\(a\)\?\(b\)\?\(c\)\?\(.*\)', 2, 2
|
:echo matchbufline(2, '\(a\)\?\(b\)\?\(c\)\?\(.*\)', 2, 2
|
||||||
\ {'submatches': v:true})
|
\ {'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
|
< The "submatches" List always contains 9 items. If a submatch
|
||||||
is not found, then an empty string is returned for that
|
is not found, then an empty string is returned for that
|
||||||
submatch.
|
submatch.
|
||||||
@@ -7494,7 +7496,8 @@ matchfuzzypos({list}, {str} [, {dict}]) *matchfuzzypos()*
|
|||||||
< results in [['testing'], [[0, 2, 6]], [99]] >
|
< results in [['testing'], [[0, 2, 6]], [99]] >
|
||||||
:echo matchfuzzypos(['clay', 'lacy'], 'la')
|
:echo matchfuzzypos(['clay', 'lacy'], 'la')
|
||||||
< results in [['lacy', 'clay'], [[0, 1], [1, 2]], [153, 133]] >
|
< 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]]
|
< results in [[{'id': 10, 'text': 'hello'}], [[2, 3]], [127]]
|
||||||
|
|
||||||
Return type: list<list<any>>
|
Return type: list<list<any>>
|
||||||
@@ -7538,15 +7541,18 @@ matchstrlist({list}, {pat} [, {dict}])
|
|||||||
|
|
||||||
Example: >
|
Example: >
|
||||||
:echo matchstrlist(['tik tok'], '\<\k\+\>')
|
: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\+\>')
|
: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
|
If "submatches" is present and is v:true, then submatches like
|
||||||
"\1", "\2", etc. are also returned. Example: >
|
"\1", "\2", etc. are also returned. Example: >
|
||||||
:echo matchstrlist(['acd'], '\(a\)\?\(b\)\?\(c\)\?\(.*\)',
|
:echo matchstrlist(['acd'], '\(a\)\?\(b\)\?\(c\)\?\(.*\)',
|
||||||
\ #{submatches: v:true})
|
\ #{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
|
< The "submatches" List always contains 9 items. If a submatch
|
||||||
is not found, then an empty string is returned for that
|
is not found, then an empty string is returned for that
|
||||||
submatch.
|
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
|
Note: Any errors will be reported in the server and may mess
|
||||||
up the display.
|
up the display.
|
||||||
Examples: >
|
Examples: >
|
||||||
:echo remote_send("gvim", ":DropAndReply " .. file, "serverid") ..
|
:echo remote_send("gvim", ":DropAndReply " .. file,
|
||||||
\ remote_read(serverid)
|
\ "serverid") .. remote_read(serverid)
|
||||||
|
|
||||||
:autocmd NONE RemoteReply *
|
:autocmd NONE RemoteReply *
|
||||||
\ echo remote_read(expand("<amatch>"))
|
\ echo remote_read(expand("<amatch>"))
|
||||||
@@ -13027,7 +13033,8 @@ python_dynamic Python 2.x interface is dynamically loaded. |has-python|
|
|||||||
python3 Python 3.x interface available. |has-python|
|
python3 Python 3.x interface available. |has-python|
|
||||||
python3_compiled Compiled with Python 3.x interface. |has-python|
|
python3_compiled Compiled with Python 3.x interface. |has-python|
|
||||||
python3_dynamic Python 3.x interface is dynamically loaded. |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|
|
pythonx Python 2.x and/or 3.x interface available. |python_x|
|
||||||
qnx QNX version of Vim.
|
qnx QNX version of Vim.
|
||||||
quickfix Compiled with |quickfix| support.
|
quickfix Compiled with |quickfix| support.
|
||||||
|
@@ -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
|
VIM USER MANUAL - by Bram Moolenaar
|
||||||
|
|
||||||
@@ -30,10 +30,10 @@ Table of contents: |usr_toc.txt|
|
|||||||
*41.1* Introduction *vim-script-intro* *script*
|
*41.1* Introduction *vim-script-intro* *script*
|
||||||
|
|
||||||
Let's start with some nomenclature. A Vim script is any file that Vim can
|
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
|
interpret and execute. This includes files written in Vim's scripting
|
||||||
like for example .vim files or configuration files like .vimrc and .gvimrc.
|
language like for example .vim files or configuration files like .vimrc and
|
||||||
These scripts may define functions, commands and settings that Vim uses to
|
.gvimrc. These scripts may define functions, commands and settings that Vim
|
||||||
customize and extend its behavior.
|
uses to customize and extend its behavior.
|
||||||
|
|
||||||
*vim-script-notation*
|
*vim-script-notation*
|
||||||
The correct notation is "Vim script" (or "Vim9 script" when refering to the
|
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}"
|
echo $"count is {i}"
|
||||||
endfor
|
endfor
|
||||||
|
|
||||||
We won't explain how `for`, `range()`and `$"string"` work until later. Follow
|
We won't explain how `for`, `range()` and `$"string"` work until later.
|
||||||
the links if you are impatient.
|
Follow the links if you are impatient.
|
||||||
|
|
||||||
|
|
||||||
TRYING OUT EXAMPLES
|
TRYING OUT EXAMPLES
|
||||||
@@ -749,7 +749,7 @@ String manipulation: *string-functions*
|
|||||||
str2list() get list of numbers from a string
|
str2list() get list of numbers from a string
|
||||||
str2nr() convert a string to a Number
|
str2nr() convert a string to a Number
|
||||||
str2float() convert a string to a Float
|
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 '\'
|
escape() escape characters in a string with a '\'
|
||||||
shellescape() escape a string for use with a shell command
|
shellescape() escape a string for use with a shell command
|
||||||
fnameescape() escape a file name for use with a Vim 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
|
range() return a List with a sequence of numbers
|
||||||
string() String representation of a List
|
string() String representation of a List
|
||||||
call() call a function with List as arguments
|
call() call a function with List as arguments
|
||||||
index() index of a value in a List or Blob
|
index() index of a value in a List
|
||||||
indexof() index in a List or Blob where an expression
|
indexof() index in a List where an expression is true
|
||||||
evaluates to true
|
|
||||||
max() maximum value in a List
|
max() maximum value in a List
|
||||||
min() minimum value in a List
|
min() minimum value in a List
|
||||||
count() count number of times a value appears 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
|
blob2list() get a list of numbers from a blob
|
||||||
list2blob() get a blob from a list of numbers
|
list2blob() get a blob from a list of numbers
|
||||||
reverse() reverse the order of numbers in a blob
|
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*
|
Other computation: *bitwise-function*
|
||||||
and() bitwise AND
|
and() bitwise AND
|
||||||
@@ -1456,9 +1457,9 @@ Various: *various-functions*
|
|||||||
|
|
||||||
luaeval() evaluate |Lua| expression
|
luaeval() evaluate |Lua| expression
|
||||||
mzeval() evaluate |MzScheme| expression
|
mzeval() evaluate |MzScheme| expression
|
||||||
perleval() evaluate Perl expression (|+perl|)
|
perleval() evaluate Perl expression
|
||||||
py3eval() evaluate Python expression (|+python3|)
|
py3eval() evaluate Python expression
|
||||||
pyeval() evaluate Python expression (|+python|)
|
pyeval() evaluate Python expression
|
||||||
pyxeval() evaluate |python_x| expression
|
pyxeval() evaluate |python_x| expression
|
||||||
rubyeval() evaluate |Ruby| 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: >
|
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
|
The function will be called six times, starting on line 10 and ending on line
|
||||||
15.
|
15.
|
||||||
|
Reference in New Issue
Block a user