doc: fix vim.api.nvim_buf_attach callback arguments

This commit is contained in:
Hirokazu Hata 2020-05-19 14:26:17 +09:00
parent 74fed7d50f
commit 52cd8bf507
No known key found for this signature in database
GPG Key ID: 9AA9860369AE0DE2
2 changed files with 6 additions and 0 deletions

View File

@ -1612,6 +1612,7 @@ nvim_buf_attach({buffer}, {send_buffer}, {opts}) *nvim_buf_attach()*
{opts} Optional parameters.
• on_lines: Lua callback invoked on change.
Return`true`to detach. Args:
• the string "lines"
• buffer handle
• b:changedtick
• first line that changed (zero-indexed)
@ -1626,11 +1627,13 @@ nvim_buf_attach({buffer}, {send_buffer}, {opts}) *nvim_buf_attach()*
• on_changedtick: Lua callback invoked on
changedtick increment without text
change. Args:
• the string "changedtick"
• buffer handle
• b:changedtick
• on_detach: Lua callback invoked on
detach. Args:
• the string "detach"
• buffer handle
• utf_sizes: include UTF-32 and UTF-16 size

View File

@ -126,6 +126,7 @@ String buffer_get_line(Buffer buffer, Integer index, Error *err)
/// @param opts Optional parameters.
/// - on_lines: Lua callback invoked on change.
/// Return `true` to detach. Args:
/// - the string "lines"
/// - buffer handle
/// - b:changedtick
/// - first line that changed (zero-indexed)
@ -136,9 +137,11 @@ String buffer_get_line(Buffer buffer, Integer index, Error *err)
/// - deleted_codeunits (if `utf_sizes` is true)
/// - on_changedtick: Lua callback invoked on changedtick
/// increment without text change. Args:
/// - the string "changedtick"
/// - buffer handle
/// - b:changedtick
/// - on_detach: Lua callback invoked on detach. Args:
/// - the string "detach"
/// - buffer handle
/// - utf_sizes: include UTF-32 and UTF-16 size of the replaced
/// region, as args to `on_lines`.