IntenseFinance/neovim
3
0
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2025-02-25 18:55:25 -06:00
Code Issues Packages Projects Releases Wiki Activity

doc: fix vim.api.nvim_buf_attach callback arguments

Browse Source
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
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
runtime/doc/api.txt
View File

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

3
src/nvim/api/buffer.c
View File

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