mirrors/neovim
1
0
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2025-09-18 09:18:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(builtin): small fixes (#24861)

Browse Source 
Also make gen_eval_files.lua render vimdoc helpExamples properly if the line
begins with the `>` marker.
This commit is contained in:
Sean Dewar
2023-08-24 13:29:40 +01:00
committed by GitHub
parent 53170579ce
commit daf7abbc42
4 changed files with 10 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
runtime/doc/builtin.txt generated
View File

@@ -4950,7 +4950,7 @@ pathshorten({path} [, {len}]) *pathshorten()*
letters). Leading '~' and '.' characters are kept. Examples: >vim letters). Leading '~' and '.' characters are kept. Examples: >vim
echo pathshorten('~/.config/nvim/autoload/file1.vim') echo pathshorten('~/.config/nvim/autoload/file1.vim')
< ~/.c/n/a/file1.vim ~ < ~/.c/n/a/file1.vim ~
>vim >vim
echo pathshorten('~/.config/nvim/autoload/file2.vim', 2) echo pathshorten('~/.config/nvim/autoload/file2.vim', 2)
< ~/.co/nv/au/file2.vim ~ < ~/.co/nv/au/file2.vim ~
It doesn't matter if the path exists or not. It doesn't matter if the path exists or not.
@@ -7219,7 +7219,7 @@ sort({list} [, {how} [, {dict}]]) *sort()* *E70
language collate en_US.UTF8 language collate en_US.UTF8
echo sort(['n', 'o', 'O', 'ö', 'p', 'z'], 'l') echo sort(['n', 'o', 'O', 'ö', 'p', 'z'], 'l')
< ['n', 'o', 'O', 'ö', 'p', 'z'] ~ < ['n', 'o', 'O', 'ö', 'p', 'z'] ~
>vim >vim
" ö is sorted after z with Swedish locale. " ö is sorted after z with Swedish locale.
language collate sv_SE.UTF8 language collate sv_SE.UTF8
echo sort(['n', 'o', 'O', 'ö', 'p', 'z'], 'l') echo sort(['n', 'o', 'O', 'ö', 'p', 'z'], 'l')
@@ -7390,7 +7390,7 @@ state([{what}]) *state()*
added. E.g, this checks if the screen has scrolled: >vim added. E.g, this checks if the screen has scrolled: >vim
if state('s') == '' if state('s') == ''
" screen has not scrolled " screen has not scrolled
<
These characters indicate the state, generally indicating that These characters indicate the state, generally indicating that
something is busy: something is busy:
m halfway a mapping, :normal command, feedkeys() or m halfway a mapping, :normal command, feedkeys() or
@@ -7958,7 +7958,6 @@ synconcealed({lnum}, {col}) *synconcealed()*
synconcealed(lnum, 4) [1, 'X', 2] synconcealed(lnum, 4) [1, 'X', 2]
synconcealed(lnum, 5) [1, 'X', 2] synconcealed(lnum, 5) [1, 'X', 2]
synconcealed(lnum, 6) [0, '', 0] synconcealed(lnum, 6) [0, '', 0]
<
synstack({lnum}, {col}) *synstack()* synstack({lnum}, {col}) *synstack()*
Return a |List|, which is the stack of syntax items at the Return a |List|, which is the stack of syntax items at the

3
runtime/lua/vim/_meta/vimfn.lua generated
View File

@@ -8765,7 +8765,7 @@ function vim.fn.srand(expr) end
--- added. E.g, this checks if the screen has scrolled: >vim --- added. E.g, this checks if the screen has scrolled: >vim
--- if state('s') == '' --- if state('s') == ''
--- " screen has not scrolled --- " screen has not scrolled
--- --- <
--- These characters indicate the state, generally indicating that --- These characters indicate the state, generally indicating that
--- something is busy: --- something is busy:
--- m halfway a mapping, :normal command, feedkeys() or --- m halfway a mapping, :normal command, feedkeys() or
@@ -9446,7 +9446,6 @@ function vim.fn.synIDtrans(synID) end
--- synconcealed(lnum, 4) [1, 'X', 2] --- synconcealed(lnum, 4) [1, 'X', 2]
--- synconcealed(lnum, 5) [1, 'X', 2] --- synconcealed(lnum, 5) [1, 'X', 2]
--- synconcealed(lnum, 6) [0, '', 0] --- synconcealed(lnum, 6) [0, '', 0]
--- <
--- ---
--- @param lnum integer --- @param lnum integer
--- @param col integer --- @param col integer

2
scripts/gen_eval_files.lua
View File

@@ -437,6 +437,8 @@ local function render_eval_doc(f, fun, write)
l = l:gsub('^ ', '') l = l:gsub('^ ', '')
if vim.startswith(l, '<') and not l:match('^<[^ \t]+>') then if vim.startswith(l, '<') and not l:match('^<[^ \t]+>') then
write('<\t\t' .. l:sub(2)) write('<\t\t' .. l:sub(2))
elseif l:match('^>[a-z0-9]*$') then
write(l)
else else
write('\t\t' .. l) write('\t\t' .. l)
end end

3
src/nvim/eval.lua
View File

@@ -10482,7 +10482,7 @@ M.funcs = {
added. E.g, this checks if the screen has scrolled: >vim added. E.g, this checks if the screen has scrolled: >vim
if state('s') == '' if state('s') == ''
" screen has not scrolled " screen has not scrolled
<
These characters indicate the state, generally indicating that These characters indicate the state, generally indicating that
something is busy: something is busy:
m halfway a mapping, :normal command, feedkeys() or m halfway a mapping, :normal command, feedkeys() or
@@ -11255,7 +11255,6 @@ M.funcs = {
synconcealed(lnum, 4) [1, 'X', 2] synconcealed(lnum, 4) [1, 'X', 2]
synconcealed(lnum, 5) [1, 'X', 2] synconcealed(lnum, 5) [1, 'X', 2]
synconcealed(lnum, 6) [0, '', 0] synconcealed(lnum, 6) [0, '', 0]
<
]=], ]=],
name = 'synconcealed', name = 'synconcealed',
params = { { 'lnum', 'integer' }, { 'col', 'integer' } }, params = { { 'lnum', 'integer' }, { 'col', 'integer' } },