From 74ca73d545daf9aff6a6b041572be062d46d51ef Mon Sep 17 00:00:00 2001 From: "Justin M. Keyes" Date: Sat, 12 Apr 2025 10:21:03 -0700 Subject: docs: misc #33330 --- runtime/lua/vim/_meta/api.lua | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) (limited to 'runtime/lua/vim/_meta/api.lua') diff --git a/runtime/lua/vim/_meta/api.lua b/runtime/lua/vim/_meta/api.lua index 62df0a7707..6afdee2317 100644 --- a/runtime/lua/vim/_meta/api.lua +++ b/runtime/lua/vim/_meta/api.lua @@ -324,12 +324,18 @@ function vim.api.nvim_buf_del_user_command(buffer, name) end --- @param name string Variable name function vim.api.nvim_buf_del_var(buffer, name) end ---- Deletes the buffer. See `:bwipeout` +--- Deletes a buffer and its metadata (like `:bwipeout`). +--- +--- To get `:bdelete` behavior, reset 'buflisted' and pass `unload=true`: +--- ```lua +--- vim.bo.buflisted = false +--- vim.api.nvim_buf_delete(0, { unload = true }) +--- ``` --- --- @param buffer integer Buffer id, or 0 for current buffer --- @param opts vim.api.keyset.buf_delete Optional parameters. Keys: ---- - force: Force deletion and ignore unsaved changes. ---- - unload: Unloaded only, do not delete. See `:bunload` +--- - force: Force deletion, ignore unsaved changes. +--- - unload: Unloaded only (`:bunload`), do not delete. function vim.api.nvim_buf_delete(buffer, opts) end --- Gets a changed tick of a buffer -- cgit