From 92672a161cc5701636214e107e959f19eb3832d4 Mon Sep 17 00:00:00 2001 From: zeertzjq Date: Tue, 16 Jan 2024 12:07:35 +0800 Subject: [PATCH] docs(builtin): remove signatures of undocumented functions (#27039) Having an empty signature causes an empty line in generated docs, so remove it. Also change ">" to ">vim" in foreach() docs. --- runtime/doc/builtin.txt | 4 +--- runtime/lua/vim/_meta/vimfn.lua | 2 +- src/nvim/eval.lua | 4 +--- 3 files changed, 3 insertions(+), 7 deletions(-) diff --git a/runtime/doc/builtin.txt b/runtime/doc/builtin.txt index cf82c478b6..775d49d2f2 100644 --- a/runtime/doc/builtin.txt +++ b/runtime/doc/builtin.txt @@ -1880,7 +1880,7 @@ foreach({expr1}, {expr2}) *foreach()* the current item. For a |Blob| |v:key| has the index of the current byte. For a |String| |v:key| has the index of the current character. - Examples: > + Examples: >vim call foreach(mylist, 'let used[v:val] = v:true') < This records the items that are in the {expr1} list. @@ -1901,7 +1901,6 @@ foreach({expr1}, {expr2}) *foreach()* When {expr2} is a Funcref errors inside a function are ignored, unless it was defined with the "abort" flag. - fullcommand({name}) *fullcommand()* Get the full command name from a short abbreviated command name; see |20.2| for details on command abbreviations. @@ -8363,7 +8362,6 @@ test_garbagecollect_now() *test_garbagecollect_now()* internally, and |v:testing| must have been set before calling any function. - timer_info([{id}]) *timer_info()* Return a list with information about timers. When {id} is given only information about this timer is diff --git a/runtime/lua/vim/_meta/vimfn.lua b/runtime/lua/vim/_meta/vimfn.lua index 59497f96e9..50f6e4da52 100644 --- a/runtime/lua/vim/_meta/vimfn.lua +++ b/runtime/lua/vim/_meta/vimfn.lua @@ -2321,7 +2321,7 @@ function vim.fn.foldtextresult(lnum) end --- the current item. For a |Blob| |v:key| has the index of the --- current byte. For a |String| |v:key| has the index of the --- current character. ---- Examples: > +--- Examples: >vim --- call foreach(mylist, 'let used[v:val] = v:true') --- + Examples: >vim call foreach(mylist, 'let used[v:val] = v:true')