commit a5a4149e9754a96c063a357c18397aa7906edf53
parent 31d6885deba01fe0e7262dca58c94220c2fe32fc
Author: luukvbaal <luukvbaal@gmail.com>
Date: Thu, 19 Dec 2024 16:04:33 +0100
docs(api): specify when decor provider on_buf is called #31634
Diffstat:
3 files changed, 6 insertions(+), 6 deletions(-)
diff --git a/runtime/doc/api.txt b/runtime/doc/api.txt
@@ -2847,8 +2847,8 @@ nvim_set_decoration_provider({ns_id}, {opts})
• on_start: called first on each screen redraw >
["start", tick]
<
- • on_buf: called for each buffer being redrawn (before window
- callbacks) >
+ • on_buf: called for each buffer being redrawn (once per
+ edit, before window callbacks) >
["buf", bufnr, tick]
<
• on_win: called when starting to redraw a specific window. >
diff --git a/runtime/lua/vim/_meta/api.lua b/runtime/lua/vim/_meta/api.lua
@@ -2134,8 +2134,8 @@ function vim.api.nvim_set_current_win(window) end
--- ```
--- ["start", tick]
--- ```
---- - on_buf: called for each buffer being redrawn (before
---- window callbacks)
+--- - on_buf: called for each buffer being redrawn (once per edit,
+--- before window callbacks)
--- ```
--- ["buf", bufnr, tick]
--- ```
diff --git a/src/nvim/api/extmark.c b/src/nvim/api/extmark.c
@@ -1012,8 +1012,8 @@ void nvim_buf_clear_namespace(Buffer buffer, Integer ns_id, Integer line_start,
/// ```
/// ["start", tick]
/// ```
-/// - on_buf: called for each buffer being redrawn (before
-/// window callbacks)
+/// - on_buf: called for each buffer being redrawn (once per edit,
+/// before window callbacks)
/// ```
/// ["buf", bufnr, tick]
/// ```