aboutsummaryrefslogtreecommitdiff
path: root/runtime/lua/vim/_meta/api.lua
diff options
context:
space:
mode:
Diffstat (limited to 'runtime/lua/vim/_meta/api.lua')
-rw-r--r--runtime/lua/vim/_meta/api.lua7
1 files changed, 7 insertions, 0 deletions
diff --git a/runtime/lua/vim/_meta/api.lua b/runtime/lua/vim/_meta/api.lua
index 61e4a28704..abda4dead0 100644
--- a/runtime/lua/vim/_meta/api.lua
+++ b/runtime/lua/vim/_meta/api.lua
@@ -2175,6 +2175,13 @@ function vim.api.nvim_set_current_win(window) end
--- ```
--- ["range", winid, bufnr, begin_row, begin_col, end_row, end_col]
--- ```
+---
+--- In addition to returning a boolean, it is also allowed to
+--- return a `skip_row, skip_col` pair of integers. This implies
+--- that this function does not need to be called until a range
+--- which continues beyond the skipped position. A single integer
+--- return value `skip_row` is short for `skip_row, 0`
+---
--- - on_end: called at the end of a redraw cycle
--- ```
--- ["end", tick]