diff options
Diffstat (limited to 'runtime/lua/vim/_meta/vimfn.lua')
| -rw-r--r-- | runtime/lua/vim/_meta/vimfn.lua | 30 |
1 files changed, 16 insertions, 14 deletions
diff --git a/runtime/lua/vim/_meta/vimfn.lua b/runtime/lua/vim/_meta/vimfn.lua index 70d1aa4a79..e393844724 100644 --- a/runtime/lua/vim/_meta/vimfn.lua +++ b/runtime/lua/vim/_meta/vimfn.lua @@ -3230,7 +3230,7 @@ function vim.fn.getmarklist(buf) end --- @return any function vim.fn.getmatches(win) end ---- Returns a Dictionary with the last known position of the +--- Returns a |Dictionary| with the last known position of the --- mouse. This can be used in a mapping for a mouse click. The --- items are: --- screenrow screen row @@ -6878,7 +6878,7 @@ function vim.fn.screenattr(row, col) end --- @return any function vim.fn.screenchar(row, col) end ---- The result is a List of Numbers. The first number is the same +--- The result is a |List| of Numbers. The first number is the same --- as what |screenchar()| returns. Further numbers are --- composing characters on top of the base character. --- This is mainly to be used for testing. @@ -7069,7 +7069,7 @@ function vim.fn.search(pattern, flags, stopline, timeout, skip) end --- without the "S" flag in 'shortmess'. This works even if --- 'shortmess' does contain the "S" flag. --- ---- This returns a Dictionary. The dictionary is empty if the +--- This returns a |Dictionary|. The dictionary is empty if the --- previous pattern was not set and "pattern" was not specified. --- --- key type meaning ~ @@ -7151,7 +7151,7 @@ function vim.fn.search(pattern, flags, stopline, timeout, skip) end --- " search again --- call searchcount() --- < ---- {options} must be a Dictionary. It can contain: +--- {options} must be a |Dictionary|. It can contain: --- key type meaning ~ --- recompute |Boolean| if |TRUE|, recompute the count --- like |n| or |N| was executed. @@ -8749,27 +8749,29 @@ function vim.fn.srand(expr) end --- current state. Mostly useful in callbacks that want to do --- work that may not always be safe. Roughly this works like: --- - callback uses state() to check if work is safe to do. ---- If yes, then do it right away. ---- Otherwise add to work queue and add SafeState autocommand. ---- - When SafeState is triggered, check with state() if the work ---- can be done now, and if yes remove it from the queue and ---- execute. +--- Yes: then do it right away. +--- No: add to work queue and add a |SafeState| autocommand. +--- - When SafeState is triggered and executes your autocommand, +--- check with `state()` if the work can be done now, and if yes +--- remove it from the queue and execute. +--- Remove the autocommand if the queue is now empty. --- Also see |mode()|. --- --- When {what} is given only characters in this string will be --- added. E.g, this checks if the screen has scrolled: >vim ---- if state('s') != '' +--- 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 ---- stuffed command ---- o operator pending or waiting for a command argument +--- stuffed command +--- o operator pending, e.g. after |d| --- a Insert mode autocomplete active --- x executing an autocommand ---- S not triggering SafeState +--- S not triggering SafeState, e.g. after |f| or a count --- c callback invoked, including timer (repeats for ---- recursiveness up to "ccc") +--- recursiveness up to "ccc") --- s screen has scrolled for messages --- --- @param what? string |