kevin/neovim
1
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2024-12-19 18:55:14 -07: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
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 10 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
runtime/doc/builtin.txt generated
View File

@ -3211,7 +3211,7 @@ has({feature}) *has()*
clipboard |clipboard| provider is available.
fname_case Case in file names matters (for Darwin and MS-Windows
this is not present).
gui_running Nvim has a GUI.
gui_running Nvim has a GUI.
iconv Can use |iconv()| for conversion.
linux Linux system.
mac MacOS system.
@ -4950,7 +4950,7 @@ pathshorten({path} [, {len}]) *pathshorten()*
letters). Leading '~' and '.' characters are kept. Examples: >vim
echo pathshorten('~/.config/nvim/autoload/file1.vim')
< ~/.c/n/a/file1.vim ~
>vim
>vim
echo pathshorten('~/.config/nvim/autoload/file2.vim', 2)
< ~/.co/nv/au/file2.vim ~
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
echo sort(['n', 'o', 'O', 'ö', 'p', 'z'], 'l')
< ['n', 'o', 'O', 'ö', 'p', 'z'] ~
>vim
>vim
" ö is sorted after z with Swedish locale.
language collate sv_SE.UTF8
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
if state('s') == ''
" screen has not scrolled
<
These characters indicate the state, generally indicating that
something is busy:
m halfway a mapping, :normal command, feedkeys() or
@ -7958,7 +7958,6 @@ synconcealed({lnum}, {col}) *synconcealed()*
synconcealed(lnum, 4) [1, 'X', 2]
synconcealed(lnum, 5) [1, 'X', 2]
synconcealed(lnum, 6) [0, '', 0]
<
synstack({lnum}, {col}) *synstack()*
Return a |List|, which is the stack of syntax items at the

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

@ -3853,7 +3853,7 @@ function vim.fn.globpath(path, expr, nosuf, list, allinks) end
--- clipboard |clipboard| provider is available.
--- fname_case Case in file names matters (for Darwin and MS-Windows
--- this is not present).
--- gui_running Nvim has a GUI.
--- gui_running Nvim has a GUI.
--- iconv Can use |iconv()| for conversion.
--- linux Linux system.
--- mac MacOS system.
@ -8765,7 +8765,7 @@ function vim.fn.srand(expr) end
--- added. E.g, this checks if the screen has scrolled: >vim
--- if state('s') == ''
--- " screen has not scrolled
---
--- <
--- These characters indicate the state, generally indicating that
--- something is busy:
--- 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, 5) [1, 'X', 2]
--- synconcealed(lnum, 6) [0, '', 0]
--- <
---
--- @param lnum 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('^ ', '')
if vim.startswith(l, '<') and not l:match('^<[^ \t]+>') then
write('<\t\t' .. l:sub(2))
elseif l:match('^>[a-z0-9]*$') then
write(l)
else
write('\t\t' .. l)
end

5
src/nvim/eval.lua
View File

@ -4730,7 +4730,7 @@ M.funcs = {
clipboard |clipboard| provider is available.
fname_case Case in file names matters (for Darwin and MS-Windows
this is not present).
gui_running Nvim has a GUI.
gui_running Nvim has a GUI.
iconv Can use |iconv()| for conversion.
linux Linux system.
mac MacOS system.
@ -10482,7 +10482,7 @@ M.funcs = {
added. E.g, this checks if the screen has scrolled: >vim
if state('s') == ''
" screen has not scrolled
<
These characters indicate the state, generally indicating that
something is busy:
m halfway a mapping, :normal command, feedkeys() or
@ -11255,7 +11255,6 @@ M.funcs = {
synconcealed(lnum, 4) [1, 'X', 2]
synconcealed(lnum, 5) [1, 'X', 2]
synconcealed(lnum, 6) [0, '', 0]
<
]=],
name = 'synconcealed',
params = { { 'lnum', 'integer' }, { 'col', 'integer' } },