diff options
Diffstat (limited to 'runtime/lua/vim/_meta/vimfn.lua')
| -rw-r--r-- | runtime/lua/vim/_meta/vimfn.lua | 21 |
1 files changed, 13 insertions, 8 deletions
diff --git a/runtime/lua/vim/_meta/vimfn.lua b/runtime/lua/vim/_meta/vimfn.lua index 4970a3023b..5504d577d6 100644 --- a/runtime/lua/vim/_meta/vimfn.lua +++ b/runtime/lua/vim/_meta/vimfn.lua @@ -899,12 +899,13 @@ function vim.fn.charidx(string, idx, countcc, utf16) end --- @return string function vim.fn.chdir(dir) end ---- Get the amount of indent for line {lnum} according the C ---- indenting rules, as with 'cindent'. +--- Get the amount of indent for line {lnum} according the +--- |C-indenting| rules, as with 'cindent'. --- The indent is counted in spaces, the value of 'tabstop' is --- relevant. {lnum} is used just like in |getline()|. --- When {lnum} is invalid -1 is returned. ---- See |C-indenting|. +--- +--- To get or set indent of lines in a string, see |vim.text.indent()|. --- --- @param lnum integer --- @return integer @@ -4430,6 +4431,8 @@ function vim.fn.id(expr) end --- |getline()|. --- When {lnum} is invalid -1 is returned. --- +--- To get or set indent of lines in a string, see |vim.text.indent()|. +--- --- @param lnum integer|string --- @return integer function vim.fn.indent(lnum) end @@ -5335,9 +5338,8 @@ function vim.fn.map(expr1, expr2) end --- When {abbr} is there and it is |TRUE| use abbreviations --- instead of mappings. --- ---- When {dict} is there and it is |TRUE| return a dictionary ---- containing all the information of the mapping with the ---- following items: *mapping-dict* +--- When {dict} is |TRUE|, return a dictionary describing the +--- mapping, with these items: *mapping-dict* --- "lhs" The {lhs} of the mapping as it would be typed --- "lhsraw" The {lhs} of the mapping as raw bytes --- "lhsrawalt" The {lhs} of the mapping as raw bytes, alternate @@ -5389,7 +5391,7 @@ function vim.fn.maparg(name, mode, abbr, dict) end --- @param mode string --- @param abbr boolean --- @param dict true ---- @return string|table<string,any> +--- @return table<string,any> function vim.fn.maparg(name, mode, abbr, dict) end --- Check if there is a mapping that matches with {name} in mode @@ -6821,6 +6823,7 @@ function vim.fn.prompt_getprompt(buf) end --- endif --- endfunc --- call prompt_setcallback(bufnr(), function('s:TextEntered')) +--- < --- --- @param buf integer|string --- @param expr string|function @@ -9328,7 +9331,9 @@ function vim.fn.state(what) end function vim.fn.stdioopen(opts) end --- Returns |standard-path| locations of various default files and ---- directories. +--- directories. The locations are driven by |base-directories| +--- which you can configure via |$NVIM_APPNAME| or the `$XDG_…` +--- environment variables. --- --- {what} Type Description ~ --- cache String Cache directory: arbitrary temporary |