diff options
author | Justin M. Keyes <justinkz@gmail.com> | 2024-04-30 04:30:21 -0700 |
---|---|---|
committer | GitHub <noreply@github.com> | 2024-04-30 04:30:21 -0700 |
commit | 71cf75f96a67aeb79ac3af6aa829bac81bd2d33d (patch) | |
tree | b6582df55b2956fb2077f2d79c2cc7b6acf37c84 /runtime/doc/api.txt | |
parent | efaf37a2b9450d56acbf48a44c3c791d00d70199 (diff) | |
download | rneovim-71cf75f96a67aeb79ac3af6aa829bac81bd2d33d.tar.gz rneovim-71cf75f96a67aeb79ac3af6aa829bac81bd2d33d.tar.bz2 rneovim-71cf75f96a67aeb79ac3af6aa829bac81bd2d33d.zip |
docs: misc #24163
- Also delete old perl scripts which are not used since 8+ years ago.
fix #23251
fix #27367
ref https://github.com/neovim/neovim/issues/2252#issuecomment-1902662577
Helped-by: Daniel Kongsgaard <dakongsgaard@gmail.com>
Co-authored-by: Kevin Pham <keevan.pham@gmail.com>
Diffstat (limited to 'runtime/doc/api.txt')
-rw-r--r-- | runtime/doc/api.txt | 16 |
1 files changed, 11 insertions, 5 deletions
diff --git a/runtime/doc/api.txt b/runtime/doc/api.txt index cc5f228920..463301693d 100644 --- a/runtime/doc/api.txt +++ b/runtime/doc/api.txt @@ -112,7 +112,11 @@ Basic types ~ Dictionary (msgpack: map) Object < - Note: empty Array is accepted as a valid argument for Dictionary parameter. + Note: + - Empty Array is accepted as a valid Dictionary parameter. + - Functions cannot cross RPC boundaries. But API functions (e.g. + |nvim_create_autocmd()|) may support Lua function parameters for non-RPC + invocations. Special types (msgpack EXT) ~ @@ -504,8 +508,9 @@ Extended marks (extmarks) represent buffer annotations that track text changes in the buffer. They can represent cursors, folds, misspelled words, anything that needs to track a logical location in the buffer over time. |api-indexing| -Extmark position works like "bar" cursor: it exists between characters. Thus, -the maximum extmark index on a line is 1 more than the character index: > +Extmark position works like a "vertical bar" cursor: it exists between +characters. Thus, the maximum extmark index on a line is 1 more than the +character index: > f o o b a r line contents 0 1 2 3 4 5 character positions (0-based) @@ -3447,7 +3452,8 @@ nvim_create_autocmd({event}, {opts}) *nvim_create_autocmd()* Vimscript function name, if string) called when the event(s) is triggered. Lua callback can return a truthy value (not `false` or `nil`) to delete the autocommand. - Receives a table argument with these keys: + Receives one argument, a table with these keys: + *event-args* • id: (number) autocommand id • event: (string) name of the triggered event |autocmd-events| @@ -3456,7 +3462,7 @@ nvim_create_autocmd({event}, {opts}) *nvim_create_autocmd()* • buf: (number) expanded value of <abuf> • file: (string) expanded value of <afile> • data: (any) arbitrary data passed from - |nvim_exec_autocmds()| + |nvim_exec_autocmds()| *event-data* • command (string) optional: Vim command to execute on event. Cannot be used with {callback} • once (boolean) optional: defaults to false. Run the |