mirror of
https://github.com/neovim/neovim
synced 2025-07-16 01:01:49 +00:00
docs: document breaking change for nvim_create_autocmd callback (#27484)
https://github.com/neovim/neovim/pull/27428 changed the semantics of callbacks passed to nvim_create_autocmd such that any truthy value will delete the autocommand (rather than just the literal boolean value `true`). Update the documentation accordingly and add an entry to `news.txt`. The behavior is now consistent between nvim_create_autocmd and nvim_buf_attach.
This commit is contained in:
@ -112,7 +112,7 @@ Integer nvim_buf_line_count(Buffer buffer, Error *err)
|
||||
/// Not for Lua callbacks.
|
||||
/// @param opts Optional parameters.
|
||||
/// - on_lines: Lua callback invoked on change.
|
||||
/// Return `true` to detach. Args:
|
||||
/// Return a truthy value (not `false` or `nil`) to detach. Args:
|
||||
/// - the string "lines"
|
||||
/// - buffer handle
|
||||
/// - b:changedtick
|
||||
@ -125,8 +125,7 @@ Integer nvim_buf_line_count(Buffer buffer, Error *err)
|
||||
/// - on_bytes: Lua callback invoked on change.
|
||||
/// This callback receives more granular information about the
|
||||
/// change compared to on_lines.
|
||||
/// Return `true` to detach.
|
||||
/// Args:
|
||||
/// Return a truthy value (not `false` or `nil`) to detach. Args:
|
||||
/// - the string "bytes"
|
||||
/// - buffer handle
|
||||
/// - b:changedtick
|
||||
|
Reference in New Issue
Block a user